xref: /aosp_15_r20/external/tink/python/examples/jwt/jwt_verify.py (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang# Copyright 2021 Google LLC
2*e7b1675dSTing-Kang Chang#
3*e7b1675dSTing-Kang Chang# Licensed under the Apache License, Version 2.0 (the "License");
4*e7b1675dSTing-Kang Chang# you may not use this file except in compliance with the License.
5*e7b1675dSTing-Kang Chang# You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang#
7*e7b1675dSTing-Kang Chang#      http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang#
9*e7b1675dSTing-Kang Chang# Unless required by applicable law or agreed to in writing, software
10*e7b1675dSTing-Kang Chang# distributed under the License is distributed on an "AS-IS" BASIS,
11*e7b1675dSTing-Kang Chang# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*e7b1675dSTing-Kang Chang# See the License for the specific language governing permissions and
13*e7b1675dSTing-Kang Chang# limitations under the License.
14*e7b1675dSTing-Kang Chang
15*e7b1675dSTing-Kang Chang# [START python-jwt-verify-example]
16*e7b1675dSTing-Kang Chang"""A utility for verifying Json Web Tokens (JWT)."""
17*e7b1675dSTing-Kang Chang
18*e7b1675dSTing-Kang Changimport datetime
19*e7b1675dSTing-Kang Chang
20*e7b1675dSTing-Kang Changfrom absl import app
21*e7b1675dSTing-Kang Changfrom absl import flags
22*e7b1675dSTing-Kang Changfrom absl import logging
23*e7b1675dSTing-Kang Changimport tink
24*e7b1675dSTing-Kang Changfrom tink import jwt
25*e7b1675dSTing-Kang Chang
26*e7b1675dSTing-Kang Chang
27*e7b1675dSTing-Kang ChangFLAGS = flags.FLAGS
28*e7b1675dSTing-Kang Chang
29*e7b1675dSTing-Kang Chang_PUBLIC_JWK_SET_PATH = flags.DEFINE_string(
30*e7b1675dSTing-Kang Chang    'public_jwk_set_path', None, 'Path to public keyset in JWK set format.')
31*e7b1675dSTing-Kang Chang_AUDIENCE = flags.DEFINE_string('audience', None,
32*e7b1675dSTing-Kang Chang                                'Audience to be used in the token')
33*e7b1675dSTing-Kang Chang_TOKEN_PATH = flags.DEFINE_string('token_path', None,
34*e7b1675dSTing-Kang Chang                                  'Path to the signature file.')
35*e7b1675dSTing-Kang Chang
36*e7b1675dSTing-Kang Chang
37*e7b1675dSTing-Kang Changdef main(argv):
38*e7b1675dSTing-Kang Chang  del argv  # Unused.
39*e7b1675dSTing-Kang Chang
40*e7b1675dSTing-Kang Chang  # Initialise Tink
41*e7b1675dSTing-Kang Chang  jwt.register_jwt_signature()
42*e7b1675dSTing-Kang Chang
43*e7b1675dSTing-Kang Chang  with open(_PUBLIC_JWK_SET_PATH.value, 'rt') as public_jwk_set_file:
44*e7b1675dSTing-Kang Chang    try:
45*e7b1675dSTing-Kang Chang      text = public_jwk_set_file.read()
46*e7b1675dSTing-Kang Chang      keyset_handle = jwt.jwk_set_to_public_keyset_handle(text)
47*e7b1675dSTing-Kang Chang    except tink.TinkError as e:
48*e7b1675dSTing-Kang Chang      logging.exception('Error reading public JWK set: %s', e)
49*e7b1675dSTing-Kang Chang      return 1
50*e7b1675dSTing-Kang Chang
51*e7b1675dSTing-Kang Chang  now = datetime.datetime.now(tz=datetime.timezone.utc)
52*e7b1675dSTing-Kang Chang  try:
53*e7b1675dSTing-Kang Chang    jwt_verify = keyset_handle.primitive(jwt.JwtPublicKeyVerify)
54*e7b1675dSTing-Kang Chang  except tink.TinkError as e:
55*e7b1675dSTing-Kang Chang    logging.exception('Error creating JwtPublicKeyVerify: %s', e)
56*e7b1675dSTing-Kang Chang    return 1
57*e7b1675dSTing-Kang Chang
58*e7b1675dSTing-Kang Chang  # Verify token
59*e7b1675dSTing-Kang Chang  with open(_TOKEN_PATH.value, 'rt') as token_file:
60*e7b1675dSTing-Kang Chang    token = token_file.read()
61*e7b1675dSTing-Kang Chang  validator = jwt.new_validator(expected_audience=_AUDIENCE.value)
62*e7b1675dSTing-Kang Chang  try:
63*e7b1675dSTing-Kang Chang    verified_jwt = jwt_verify.verify_and_decode(token, validator)
64*e7b1675dSTing-Kang Chang    expires_in = verified_jwt.expiration() - now
65*e7b1675dSTing-Kang Chang    logging.info('Token is valid and expires in %s seconds', expires_in.seconds)
66*e7b1675dSTing-Kang Chang    return 0
67*e7b1675dSTing-Kang Chang  except tink.TinkError as e:
68*e7b1675dSTing-Kang Chang    logging.info('JWT verification failed: %s', e)
69*e7b1675dSTing-Kang Chang    return 1
70*e7b1675dSTing-Kang Chang
71*e7b1675dSTing-Kang Chang
72*e7b1675dSTing-Kang Changif __name__ == '__main__':
73*e7b1675dSTing-Kang Chang  flags.mark_flags_as_required(['audience', 'token_path'])
74*e7b1675dSTing-Kang Chang  app.run(main)
75*e7b1675dSTing-Kang Chang
76*e7b1675dSTing-Kang Chang# [END python-jwt-verify-example]
77