xref: /aosp_15_r20/external/tink/cc/jwt/jwt_public_key_verify.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2021 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 ///////////////////////////////////////////////////////////////////////////////
16 
17 #ifndef TINK_JWT_JWT_PUBLIC_KEY_VERIFY_H_
18 #define TINK_JWT_JWT_PUBLIC_KEY_VERIFY_H_
19 
20 #include "absl/strings/string_view.h"
21 #include "tink/util/status.h"
22 #include "tink/util/statusor.h"
23 #include "tink/jwt/verified_jwt.h"
24 #include "tink/jwt/jwt_validator.h"
25 
26 namespace crypto {
27 namespace tink {
28 
29 ///////////////////////////////////////////////////////////////////////////////
30 // Interface for verifying signed JWT.
31 //
32 // Sees RFC 7519 and RFC 7515. Security guarantees: similar to PublicKeyVerify.
33 class JwtPublicKeyVerify {
34  public:
35   // Verifies and decodes a JWT token in the JWS compact serialization format.
36   //
37   // The JWT is validated against the rules in validator. That is, every claim
38   // in validator must also be present in the JWT. For example, if validator
39   // contains an issuer (iss) claim, the JWT must contain an identical claim.
40   // The JWT can contain claims that are NOT in the validator. However, if the
41   // JWT contains a list of audiences, the validator must also contain an
42   // audience in the list.
43   //
44   // If the JWT contains timestamp claims such as expiration (exp), issued_at
45   // (iat) or not_before (nbf), they will also be validated. validator allows to
46   // set a clock skew, to deal with small clock differences among different
47   // machines.
48   virtual crypto::tink::util::StatusOr<VerifiedJwt> VerifyAndDecode(
49       absl::string_view compact, const JwtValidator& validator) const = 0;
50 
51   virtual ~JwtPublicKeyVerify() = default;
52 };
53 
54 }  // namespace tink
55 }  // namespace crypto
56 
57 #endif  // TINK_JWT_JWT_PUBLIC_KEY_VERIFY_H_
58