summaryrefslogtreecommitdiff
path: root/src/scm/webid-oidc/oidc-id-token.scm
blob: abef88dfd81ef4889525a71e41a3521f31e3251d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
;; disfluid, implementation of the Solid specification
;; Copyright (C) 2020, 2021  Vivien Kraus

;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU Affero General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU Affero General Public License for more details.

;; You should have received a copy of the GNU Affero General Public License
;; along with this program.  If not, see <https://www.gnu.org/licenses/>.

(define-module (webid-oidc oidc-id-token)
  #:use-module (webid-oidc oidc-configuration)
  #:use-module (webid-oidc errors)
  #:use-module (webid-oidc jws)
  #:use-module (webid-oidc jwk)
  #:use-module (webid-oidc jti)
  #:use-module (webid-oidc web-i18n)
  #:use-module ((webid-oidc stubs) #:prefix stubs:)
  #:use-module ((webid-oidc parameters) #:prefix p:)
  #:use-module (web uri)
  #:use-module (web client)
  #:use-module (ice-9 optargs)
  #:use-module (ice-9 exceptions)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-19)
  #:declarative? #t
  #:export
  (
   &invalid-id-token
   make-invalid-id-token
   invalid-id-token?

   the-id-token
   id-token?

   id-token-alg
   id-token-webid
   id-token-iss
   id-token-sub
   id-token-aud
   id-token-nonce
   id-token-iat
   id-token-exp

   id-token-decode
   issue-id-token
   ))

(define-exception-type
  &invalid-id-token
  &external-error
  make-invalid-id-token
  invalid-id-token?)

(define (the-id-token x)
  (with-exception-handler
      (lambda (error)
        (let ((final-message
               (cond
                ((and (invalid-jws? error)
                      (exception-with-message? error))
                 (format #f (G_ "this is not an ID token, because it is not even a JWS: ~a")
                         (exception-message error)))
                ((invalid-jws? error)
                 (format #f (G_ "this is not an ID token, because it is not even a JWS")))
                ((exception-with-message? error)
                 (format #f (G_ "this is not an ID token: ~a")
                         (exception-message error)))
                (else
                 (format #f (G_ "this is not an ID token"))))))
          (raise-exception
           (make-exception
            (make-invalid-id-token)
            (make-exception-with-message final-message)
            error))))
    (lambda ()
      (match (the-jws x)
        ((header . payload)
         (let examine-payload ((payload payload)
                               (webid #f)
                               (iss #f)
                               (sub #f)
                               (aud #f)
                               (nonce #f)
                               (iat #f)
                               (exp #f)
                               (other-fields '()))
           (match payload
             (()
              (unless (and webid iss sub aud nonce iat exp)
                (fail (format #f (G_ "the payload is missing ~s")
                              `(,@(if webid '() '("webid"))
                                ,@(if iss '() '("iss"))
                                ,@(if sub '() '("sub"))
                                ,@(if aud '() '("aud"))
                                ,@(if nonce '() '("nonce"))
                                ,@(if iat '() '("iat"))
                                ,@(if exp '() '("exp"))))))
              `(,header
                . ((webid . ,(uri->string webid))
                   (iss . ,(uri->string iss))
                   (sub . ,sub)
                   (aud . ,(uri->string aud))
                   (nonce . ,nonce)
                   (iat . ,(time-second (date->time-utc iat)))
                   (exp . ,(time-second (date->time-utc exp))))))
             ((('webid . (? string? (= string->uri (? uri? webid-given)))) payload ...)
              (examine-payload payload
                               (or webid webid-given)
                               iss sub aud nonce iat exp other-fields))
             ((('webid . invalid) payload ...)
              (fail (format #f (G_ "the \"webid\" field should be an URI, ~s is given")
                            invalid)))
             ((('iss . (? string? (= string->uri (? uri? iss-given)))) payload ...)
              (examine-payload payload webid
                               (or iss iss-given)
                               sub aud nonce iat exp other-fields))
             ((('iss . invalid) payload ...)
              (fail (format #f (G_ "the \"iss\" field should be an URI, ~s is given")
                            invalid)))
             ((('sub . (? string? sub-given)) payload ...)
              (examine-payload payload webid iss
                               (or sub sub-given)
                               aud nonce iat exp other-fields))
             ((('sub . invalid) payload ...)
              (fail (format #f (G_ "the \"sub\" field should be a string, ~s is given")
                            invalid)))
             ((('aud . (? string? (= string->uri (? uri? aud-given)))) payload ...)
              (examine-payload payload webid iss sub
                               (or aud aud-given)
                               nonce iat exp other-fields))
             ((('aud . invalid) payload ...)
              (fail (format #f (G_ "the \"aud\" field should be an URI, ~s is given")
                            invalid)))
             ((('nonce . (? string? nonce-given)) payload ...)
              (examine-payload payload webid iss sub aud
                               (or nonce nonce-given)
                               iat exp other-fields))
             ((('nonce . invalid) payload ...)
              (fail (format #f (G_ "the \"nonce\" field should be a string, ~s is given")
                            invalid)))
             ((('iat . (? (lambda (x) (>= x 0)) (? integer? iat-given))) payload ...)
              (examine-payload payload webid iss sub aud nonce
                               (or iat (time-utc->date (make-time time-utc 0 iat-given)))
                               exp other-fields))
             ((('iat . invalid) payload ...)
              (fail (format #f (G_ "the \"iat\" field should be a timestamp, ~s is given")
                            invalid)))
             ((('exp . (? (lambda (x) (>= x 0)) (? integer? exp-given))) payload ...)
              (examine-payload payload webid iss sub aud nonce iat
                               (or exp (time-utc->date (make-time time-utc 0 exp-given)))
                               other-fields))
             ((('exp . invalid) payload ...)
              (fail (format #f (G_ "the \"exp\" field should be a timestamp, ~s is given")
                            invalid)))
             ((field payload ...)
              (examine-payload payload webid iss sub aud nonce iat exp
                               `(,field ,@other-fields)))
             (else
              (fail (format #f (G_ "the payload should be a JSON object")))))))))))

(define (id-token? x)
  (false-if-exception
   (the-id-token x)))

(define (id-token-alg code)
  (match (the-id-token code)
    ((header . _)
     (string->symbol (assq-ref header 'alg)))))

(define (id-token-webid code)
  (match (the-id-token code)
    ((_ . payload)
     (string->uri (assq-ref payload 'webid)))))

(define (id-token-iss code)
  (match (the-id-token code)
    ((_ . payload)
     (string->uri (assq-ref payload 'iss)))))

(define (id-token-sub code)
  (match (the-id-token code)
    ((_ . payload)
     (assq-ref payload 'sub))))

(define (id-token-aud code)
  (match (the-id-token code)
    ((_ . payload)
     (string->uri (assq-ref payload 'aud)))))

(define (id-token-nonce code)
  (match (the-id-token code)
    ((_ . payload)
     (assq-ref payload 'nonce))))

(define (id-token-iat code)
  (match (the-id-token code)
    ((_ . payload)
     (time-utc->date
      (make-time time-utc 0 (assq-ref payload 'iat))))))

(define (id-token-exp code)
  (match (the-id-token code)
    ((_ . payload)
     (time-utc->date
      (make-time time-utc 0 (assq-ref payload 'exp))))))

(define* (id-token-decode str #:key (http-get http-get))
  (with-exception-handler
      (lambda (error)
        (let ((final-message
               (if (exception-with-message? error)
                   (format #f (G_ "the ID token is invalid: ~a")
                           (exception-message error))
                   (format #f (G_ "the ID token is invalid")))))
          (raise-exception
           (make-exception
            (make-invalid-id-token)
            (make-exception-with-message final-message)
            error))))
    (lambda ()
      (jws-decode
       str
       (lambda (token)
         (let ((iss (id-token-iss token)))
           (let* ((cfg
                   (with-exception-handler
                       (lambda (error)
                         (let ((final-message
                                (if (exception-with-message? error)
                                    (format #f (G_ "I cannot query the identity provider configuration: ~a")
                                            (exception-message error))
                                    (format #f (G_ "I cannot query the identity provider configuratioon")))))
                           (raise-exception
                            (make-exception
                             (make-cannot-query-identity-provider iss)
                             (make-exception-with-message final-message)
                             error))))
                     (lambda ()
                       (get-oidc-configuration
                        (uri-host iss)
                        #:userinfo (uri-userinfo iss)
                        #:port (uri-port iss)
                        #:http-get http-get))))
                  (jwks
                   (with-exception-handler
                       (lambda (error)
                         (raise-exception
                          (make-exception
                           (make-cannot-query-identity-provider iss)
                           (make-exception-with-message
                            (if (exception-with-message? error)
                                (format #f (G_ "I cannot query the JWKS URI of the identity provider: ~a")
                                        (exception-message error))
                                (format #f (G_ "I cannot query the JWKS URI of the identity provider")))))))
                     (lambda ()
                       (oidc-configuration-jwks cfg #:http-get http-get)))))
             (let ((iat (id-token-iat token))
                   (exp (id-token-exp token))
                   (current-date ((p:current-date))))
               (let ((iat-s (time-second (date->time-utc iat)))
                     (exp-s (time-second (date->time-utc exp)))
                     (current-s (time-second (date->time-utc current-date))))
                 (when (>= iat-s (+ current-s 5))
                   (let ((final-message
                          (format #f (G_ "the ID token is signed in the future, ~a, relative to current ~a")
                                  (date->string iat)
                                  (date->string current-date))))
                     (raise-exception
                      (make-exception
                       (make-signed-in-future iat current-date)
                       (make-exception-with-message final-message)))))
                 (when (>= current-s exp-s)
                   (let ((final-message
                          (format #f (G_ "the ID token expired ~a, which is in the past (from ~a)")
                                  (date->string exp)
                                  (date->string current-date))))
                     (raise-exception
                      (make-exception
                       (make-expired exp current-date)
                       (make-exception-with-message final-message)))))))
             jwks)))))))

(define (id-token-encode id-token key)
  (with-exception-handler
      (lambda (error)
        (let ((final-message
               (if (exception-with-message? error)
                   (format #f (G_ "cannot encode the ID token: ~a")
                           (exception-message error))
                   (format #f (G_ "cannot encode the ID token")))))
          (raise-exception
           (make-exception-with-message final-message))))
    (lambda ()
      (jws-encode id-token key))))

(define* (issue-id-token
          issuer-key
          #:key
          (webid #f)
          (iss #f)
          (sub #f)
          (aud #f)
          (validity 3600))
  (unless sub
    (set! sub (uri->string webid)))
  (let* ((iat (time-second (date->time-utc ((p:current-date)))))
         (exp (+ iat validity)))
    (jws-encode
     (the-id-token
      `(((alg . ,(symbol->string (alg issuer-key))))
        . ((webid . ,(uri->string webid))
           (iss . ,(uri->string iss))
           (sub . ,sub)
           (aud . ,(uri->string aud))
           (nonce . ,(stubs:random 12))
           (iat . ,iat)
           (exp . ,exp))))
     issuer-key)))