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_MAC_H_ 18 #define TINK_JWT_JWT_MAC_H_ 19 20 #include <string> 21 22 #include "absl/strings/string_view.h" 23 #include "tink/jwt/jwt_validator.h" 24 #include "tink/jwt/raw_jwt.h" 25 #include "tink/jwt/verified_jwt.h" 26 #include "tink/util/status.h" 27 #include "tink/util/statusor.h" 28 29 namespace crypto { 30 namespace tink { 31 32 /////////////////////////////////////////////////////////////////////////////// 33 // Interface for authenticating and verifying JWT with JWS MAC. 34 // 35 // Sees RFC 7519 and RFC 7515. Security guarantees: similar to MAC. 36 class JwtMac { 37 public: 38 // Computes a MAC and encodes the raw JWT token and the MAC in the JWS compact 39 // serialization format. 40 virtual crypto::tink::util::StatusOr<std::string> ComputeMacAndEncode( 41 const RawJwt& token) const = 0; 42 43 // Verifies and decodes a JWT token in the JWS compact serialization format. 44 // 45 // The JWT is validated against the rules in validator. That is, every claim 46 // in validator must also be present in the JWT. For example, if validator 47 // contains an issuer (iss) claim, the JWT must contain an identical claim. 48 // The JWT can contain claims that are NOT in the validator. However, if the 49 // JWT contains a list of audiences, the validator must also contain an 50 // audience in the list. 51 // 52 // If the JWT contains timestamp claims such as expiration (exp), issued_at 53 // (iat) or not_before (nbf), they will also be validated. validator allows to 54 // set a clock skew, to deal with small clock differences among different 55 // machines. 56 virtual crypto::tink::util::StatusOr<VerifiedJwt> VerifyMacAndDecode( 57 absl::string_view compact, const JwtValidator& validator) const = 0; 58 59 virtual ~JwtMac() = default; 60 }; 61 62 } // namespace tink 63 } // namespace crypto 64 65 #endif // TINK_JWT_JWT_MAC_H_ 66