builder.go 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. /*-
  2. * Copyright 2016 Zbigniew Mandziejewicz
  3. * Copyright 2016 Square, Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. package jwt
  18. import (
  19. "bytes"
  20. "reflect"
  21. "gopkg.in/square/go-jose.v2/json"
  22. "gopkg.in/square/go-jose.v2"
  23. )
  24. // Builder is a utility for making JSON Web Tokens. Calls can be chained, and
  25. // errors are accumulated until the final call to CompactSerialize/FullSerialize.
  26. type Builder interface {
  27. // Claims encodes claims into JWE/JWS form. Multiple calls will merge claims
  28. // into single JSON object. If you are passing private claims, make sure to set
  29. // struct field tags to specify the name for the JSON key to be used when
  30. // serializing.
  31. Claims(i interface{}) Builder
  32. // Token builds a JSONWebToken from provided data.
  33. Token() (*JSONWebToken, error)
  34. // FullSerialize serializes a token using the full serialization format.
  35. FullSerialize() (string, error)
  36. // CompactSerialize serializes a token using the compact serialization format.
  37. CompactSerialize() (string, error)
  38. }
  39. // NestedBuilder is a utility for making Signed-Then-Encrypted JSON Web Tokens.
  40. // Calls can be chained, and errors are accumulated until final call to
  41. // CompactSerialize/FullSerialize.
  42. type NestedBuilder interface {
  43. // Claims encodes claims into JWE/JWS form. Multiple calls will merge claims
  44. // into single JSON object. If you are passing private claims, make sure to set
  45. // struct field tags to specify the name for the JSON key to be used when
  46. // serializing.
  47. Claims(i interface{}) NestedBuilder
  48. // Token builds a NestedJSONWebToken from provided data.
  49. Token() (*NestedJSONWebToken, error)
  50. // FullSerialize serializes a token using the full serialization format.
  51. FullSerialize() (string, error)
  52. // CompactSerialize serializes a token using the compact serialization format.
  53. CompactSerialize() (string, error)
  54. }
  55. type builder struct {
  56. payload map[string]interface{}
  57. err error
  58. }
  59. type signedBuilder struct {
  60. builder
  61. sig jose.Signer
  62. }
  63. type encryptedBuilder struct {
  64. builder
  65. enc jose.Encrypter
  66. }
  67. type nestedBuilder struct {
  68. builder
  69. sig jose.Signer
  70. enc jose.Encrypter
  71. }
  72. // Signed creates builder for signed tokens.
  73. func Signed(sig jose.Signer) Builder {
  74. return &signedBuilder{
  75. sig: sig,
  76. }
  77. }
  78. // Encrypted creates builder for encrypted tokens.
  79. func Encrypted(enc jose.Encrypter) Builder {
  80. return &encryptedBuilder{
  81. enc: enc,
  82. }
  83. }
  84. // SignedAndEncrypted creates builder for signed-then-encrypted tokens.
  85. // ErrInvalidContentType will be returned if encrypter doesn't have JWT content type.
  86. func SignedAndEncrypted(sig jose.Signer, enc jose.Encrypter) NestedBuilder {
  87. if contentType, _ := enc.Options().ExtraHeaders[jose.HeaderContentType].(jose.ContentType); contentType != "JWT" {
  88. return &nestedBuilder{
  89. builder: builder{
  90. err: ErrInvalidContentType,
  91. },
  92. }
  93. }
  94. return &nestedBuilder{
  95. sig: sig,
  96. enc: enc,
  97. }
  98. }
  99. func (b builder) claims(i interface{}) builder {
  100. if b.err != nil {
  101. return b
  102. }
  103. m, ok := i.(map[string]interface{})
  104. switch {
  105. case ok:
  106. return b.merge(m)
  107. case reflect.Indirect(reflect.ValueOf(i)).Kind() == reflect.Struct:
  108. m, err := normalize(i)
  109. if err != nil {
  110. return builder{
  111. err: err,
  112. }
  113. }
  114. return b.merge(m)
  115. default:
  116. return builder{
  117. err: ErrInvalidClaims,
  118. }
  119. }
  120. }
  121. func normalize(i interface{}) (map[string]interface{}, error) {
  122. m := make(map[string]interface{})
  123. raw, err := json.Marshal(i)
  124. if err != nil {
  125. return nil, err
  126. }
  127. d := json.NewDecoder(bytes.NewReader(raw))
  128. d.UseNumber()
  129. if err := d.Decode(&m); err != nil {
  130. return nil, err
  131. }
  132. return m, nil
  133. }
  134. func (b *builder) merge(m map[string]interface{}) builder {
  135. p := make(map[string]interface{})
  136. for k, v := range b.payload {
  137. p[k] = v
  138. }
  139. for k, v := range m {
  140. p[k] = v
  141. }
  142. return builder{
  143. payload: p,
  144. }
  145. }
  146. func (b *builder) token(p func(interface{}) ([]byte, error), h []jose.Header) (*JSONWebToken, error) {
  147. return &JSONWebToken{
  148. payload: p,
  149. Headers: h,
  150. }, nil
  151. }
  152. func (b *signedBuilder) Claims(i interface{}) Builder {
  153. return &signedBuilder{
  154. builder: b.builder.claims(i),
  155. sig: b.sig,
  156. }
  157. }
  158. func (b *signedBuilder) Token() (*JSONWebToken, error) {
  159. sig, err := b.sign()
  160. if err != nil {
  161. return nil, err
  162. }
  163. h := make([]jose.Header, len(sig.Signatures))
  164. for i, v := range sig.Signatures {
  165. h[i] = v.Header
  166. }
  167. return b.builder.token(sig.Verify, h)
  168. }
  169. func (b *signedBuilder) CompactSerialize() (string, error) {
  170. sig, err := b.sign()
  171. if err != nil {
  172. return "", err
  173. }
  174. return sig.CompactSerialize()
  175. }
  176. func (b *signedBuilder) FullSerialize() (string, error) {
  177. sig, err := b.sign()
  178. if err != nil {
  179. return "", err
  180. }
  181. return sig.FullSerialize(), nil
  182. }
  183. func (b *signedBuilder) sign() (*jose.JSONWebSignature, error) {
  184. if b.err != nil {
  185. return nil, b.err
  186. }
  187. p, err := json.Marshal(b.payload)
  188. if err != nil {
  189. return nil, err
  190. }
  191. return b.sig.Sign(p)
  192. }
  193. func (b *encryptedBuilder) Claims(i interface{}) Builder {
  194. return &encryptedBuilder{
  195. builder: b.builder.claims(i),
  196. enc: b.enc,
  197. }
  198. }
  199. func (b *encryptedBuilder) CompactSerialize() (string, error) {
  200. enc, err := b.encrypt()
  201. if err != nil {
  202. return "", err
  203. }
  204. return enc.CompactSerialize()
  205. }
  206. func (b *encryptedBuilder) FullSerialize() (string, error) {
  207. enc, err := b.encrypt()
  208. if err != nil {
  209. return "", err
  210. }
  211. return enc.FullSerialize(), nil
  212. }
  213. func (b *encryptedBuilder) Token() (*JSONWebToken, error) {
  214. enc, err := b.encrypt()
  215. if err != nil {
  216. return nil, err
  217. }
  218. return b.builder.token(enc.Decrypt, []jose.Header{enc.Header})
  219. }
  220. func (b *encryptedBuilder) encrypt() (*jose.JSONWebEncryption, error) {
  221. if b.err != nil {
  222. return nil, b.err
  223. }
  224. p, err := json.Marshal(b.payload)
  225. if err != nil {
  226. return nil, err
  227. }
  228. return b.enc.Encrypt(p)
  229. }
  230. func (b *nestedBuilder) Claims(i interface{}) NestedBuilder {
  231. return &nestedBuilder{
  232. builder: b.builder.claims(i),
  233. sig: b.sig,
  234. enc: b.enc,
  235. }
  236. }
  237. func (b *nestedBuilder) Token() (*NestedJSONWebToken, error) {
  238. enc, err := b.signAndEncrypt()
  239. if err != nil {
  240. return nil, err
  241. }
  242. return &NestedJSONWebToken{
  243. enc: enc,
  244. Headers: []jose.Header{enc.Header},
  245. }, nil
  246. }
  247. func (b *nestedBuilder) CompactSerialize() (string, error) {
  248. enc, err := b.signAndEncrypt()
  249. if err != nil {
  250. return "", err
  251. }
  252. return enc.CompactSerialize()
  253. }
  254. func (b *nestedBuilder) FullSerialize() (string, error) {
  255. enc, err := b.signAndEncrypt()
  256. if err != nil {
  257. return "", err
  258. }
  259. return enc.FullSerialize(), nil
  260. }
  261. func (b *nestedBuilder) signAndEncrypt() (*jose.JSONWebEncryption, error) {
  262. if b.err != nil {
  263. return nil, b.err
  264. }
  265. p, err := json.Marshal(b.payload)
  266. if err != nil {
  267. return nil, err
  268. }
  269. sig, err := b.sig.Sign(p)
  270. if err != nil {
  271. return nil, err
  272. }
  273. p2, err := sig.CompactSerialize()
  274. if err != nil {
  275. return nil, err
  276. }
  277. return b.enc.Encrypt([]byte(p2))
  278. }