001/* 002 * nimbus-jose-jwt 003 * 004 * Copyright 2012-2016, Connect2id Ltd. 005 * 006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use 007 * this file except in compliance with the License. You may obtain a copy of the 008 * License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, software distributed 013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the 015 * specific language governing permissions and limitations under the License. 016 */ 017 018package com.nimbusds.jose.crypto; 019 020 021import java.security.InvalidKeyException; 022import java.security.Signature; 023import java.security.SignatureException; 024import java.security.interfaces.RSAPublicKey; 025import java.util.Set; 026 027import com.nimbusds.jose.crypto.impl.CriticalHeaderParamsDeferral; 028import com.nimbusds.jose.crypto.impl.RSASSA; 029import com.nimbusds.jose.crypto.impl.RSASSAProvider; 030import net.jcip.annotations.ThreadSafe; 031 032import com.nimbusds.jose.*; 033import com.nimbusds.jose.jwk.RSAKey; 034import com.nimbusds.jose.util.Base64URL; 035 036 037/** 038 * RSA Signature-Scheme-with-Appendix (RSASSA) verifier of 039 * {@link com.nimbusds.jose.JWSObject JWS objects}. Expects a public RSA key. 040 * 041 * <p>See RFC 7518, sections 042 * <a href="https://tools.ietf.org/html/rfc7518#section-3.3">3.3</a> and 043 * <a href="https://tools.ietf.org/html/rfc7518#section-3.5">3.5</a> for more 044 * information. 045 * 046 * <p>This class is thread-safe. 047 * 048 * <p>Supports the following algorithms: 049 * 050 * <ul> 051 * <li>{@link com.nimbusds.jose.JWSAlgorithm#RS256} 052 * <li>{@link com.nimbusds.jose.JWSAlgorithm#RS384} 053 * <li>{@link com.nimbusds.jose.JWSAlgorithm#RS512} 054 * <li>{@link com.nimbusds.jose.JWSAlgorithm#PS256} 055 * <li>{@link com.nimbusds.jose.JWSAlgorithm#PS384} 056 * <li>{@link com.nimbusds.jose.JWSAlgorithm#PS512} 057 * </ul> 058 * 059 * <p>Supports the 060 * {@link com.nimbusds.jose.crypto.bc.BouncyCastleFIPSProviderSingleton 061 * BouncyCastle FIPS provider} for the PSxxx family of JWS algorithms. 062 * 063 * @author Vladimir Dzhuvinov 064 * @version 2015-06-02 065 */ 066@ThreadSafe 067public class RSASSAVerifier extends RSASSAProvider implements JWSVerifier, CriticalHeaderParamsAware { 068 069 070 /** 071 * The critical header policy. 072 */ 073 private final CriticalHeaderParamsDeferral critPolicy = new CriticalHeaderParamsDeferral(); 074 075 076 /** 077 * The public RSA key. 078 */ 079 private final RSAPublicKey publicKey; 080 081 082 /** 083 * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier. 084 * 085 * @param publicKey The public RSA key. Must not be {@code null}. 086 */ 087 public RSASSAVerifier(final RSAPublicKey publicKey) { 088 089 this(publicKey, null); 090 } 091 092 093 /** 094 * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier. 095 * 096 * @param rsaJWK The RSA JSON Web Key (JWK). Must not be {@code null}. 097 * 098 * @throws JOSEException If the RSA JWK extraction failed. 099 */ 100 public RSASSAVerifier(final RSAKey rsaJWK) 101 throws JOSEException { 102 103 this(rsaJWK.toRSAPublicKey(), null); 104 } 105 106 107 /** 108 * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier. 109 * 110 * @param publicKey The public RSA key. Must not be {@code null}. 111 * @param defCritHeaders The names of the critical header parameters 112 * that are deferred to the application for 113 * processing, empty set or {@code null} if none. 114 */ 115 public RSASSAVerifier(final RSAPublicKey publicKey, 116 final Set<String> defCritHeaders) { 117 118 if (publicKey == null) { 119 throw new IllegalArgumentException("The public RSA key must not be null"); 120 } 121 122 this.publicKey = publicKey; 123 124 critPolicy.setDeferredCriticalHeaderParams(defCritHeaders); 125 } 126 127 128 /** 129 * Gets the public RSA key. 130 * 131 * @return The public RSA key. 132 */ 133 public RSAPublicKey getPublicKey() { 134 135 return publicKey; 136 } 137 138 139 @Override 140 public Set<String> getProcessedCriticalHeaderParams() { 141 142 return critPolicy.getProcessedCriticalHeaderParams(); 143 } 144 145 146 @Override 147 public Set<String> getDeferredCriticalHeaderParams() { 148 149 return critPolicy.getDeferredCriticalHeaderParams(); 150 } 151 152 153 @Override 154 public boolean verify(final JWSHeader header, 155 final byte[] signedContent, 156 final Base64URL signature) 157 throws JOSEException { 158 159 if (! critPolicy.headerPasses(header)) { 160 return false; 161 } 162 163 final Signature verifier = RSASSA.getSignerAndVerifier(header.getAlgorithm(), getJCAContext().getProvider()); 164 165 try { 166 verifier.initVerify(publicKey); 167 168 } catch (InvalidKeyException e) { 169 throw new JOSEException("Invalid public RSA key: " + e.getMessage(), e); 170 } 171 172 try { 173 verifier.update(signedContent); 174 return verifier.verify(signature.decode()); 175 176 } catch (SignatureException e) { 177 return false; 178 } 179 } 180}