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 com.nimbusds.jose.CriticalHeaderParamsAware;
022import com.nimbusds.jose.JOSEException;
023import com.nimbusds.jose.JWSHeader;
024import com.nimbusds.jose.JWSVerifier;
025import com.nimbusds.jose.crypto.impl.CriticalHeaderParamsDeferral;
026import com.nimbusds.jose.crypto.impl.RSASSA;
027import com.nimbusds.jose.crypto.impl.RSASSAProvider;
028import com.nimbusds.jose.jwk.RSAKey;
029import com.nimbusds.jose.util.Base64URL;
030import net.jcip.annotations.ThreadSafe;
031
032import java.security.InvalidKeyException;
033import java.security.Signature;
034import java.security.SignatureException;
035import java.security.interfaces.RSAPublicKey;
036import java.util.Objects;
037import java.util.Set;
038
039
040/**
041 * RSA Signature-Scheme-with-Appendix (RSASSA) verifier of 
042 * {@link com.nimbusds.jose.JWSObject JWS objects}. Expects a public RSA key.
043 *
044 * <p>See RFC 7518, sections
045 * <a href="https://tools.ietf.org/html/rfc7518#section-3.3">3.3</a> and
046 * <a href="https://tools.ietf.org/html/rfc7518#section-3.5">3.5</a> for more
047 * information.
048 *
049 * <p>This class is thread-safe.
050 *
051 * <p>Supports the following algorithms:
052 *
053 * <ul>
054 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#RS256}
055 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#RS384}
056 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#RS512}
057 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#PS256}
058 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#PS384}
059 *     <li>{@link com.nimbusds.jose.JWSAlgorithm#PS512}
060 * </ul>
061 *
062 * <p>Supports the BouncyCastle FIPS provider for the PSxxx family of JWS algorithms.
063 * 
064 * @author Vladimir Dzhuvinov
065 * @version 2024-04-20
066 */
067@ThreadSafe
068public class RSASSAVerifier extends RSASSAProvider implements JWSVerifier, CriticalHeaderParamsAware {
069
070
071        /**
072         * The critical header policy.
073         */
074        private final CriticalHeaderParamsDeferral critPolicy = new CriticalHeaderParamsDeferral();
075
076
077        /**
078         * The public RSA key.
079         */
080        private final RSAPublicKey publicKey;
081
082
083        /**
084         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
085         *
086         * @param publicKey The public RSA key. Must not be {@code null}.
087         */
088        public RSASSAVerifier(final RSAPublicKey publicKey) {
089
090                this(publicKey, null);
091        }
092
093
094        /**
095         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
096         *
097         * @param rsaJWK The RSA JSON Web Key (JWK). Must not be {@code null}.
098         *
099         * @throws JOSEException If the RSA JWK extraction failed.
100         */
101        public RSASSAVerifier(final RSAKey rsaJWK)
102                throws JOSEException {
103
104                this(rsaJWK.toRSAPublicKey(), null);
105        }
106
107
108        /**
109         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
110         *
111         * @param publicKey      The public RSA key. Must not be {@code null}.
112         * @param defCritHeaders The names of the critical header parameters
113         *                       that are deferred to the application for
114         *                       processing, empty set or {@code null} if none.
115         */
116        public RSASSAVerifier(final RSAPublicKey publicKey,
117                              final Set<String> defCritHeaders) {
118
119                this.publicKey = Objects.requireNonNull(publicKey);
120                critPolicy.setDeferredCriticalHeaderParams(defCritHeaders);
121        }
122
123
124        /**
125         * Gets the public RSA key.
126         *
127         * @return The public RSA key.
128         */
129        public RSAPublicKey getPublicKey() {
130
131                return publicKey;
132        }
133
134
135        @Override
136        public Set<String> getProcessedCriticalHeaderParams() {
137
138                return critPolicy.getProcessedCriticalHeaderParams();
139        }
140
141
142        @Override
143        public Set<String> getDeferredCriticalHeaderParams() {
144
145                return critPolicy.getDeferredCriticalHeaderParams();
146        }
147
148
149        @Override
150        public boolean verify(final JWSHeader header,
151                              final byte[] signedContent, 
152                              final Base64URL signature)
153                throws JOSEException {
154
155                if (! critPolicy.headerPasses(header)) {
156                        return false;
157                }
158
159                final Signature verifier = RSASSA.getSignerAndVerifier(header.getAlgorithm(), getJCAContext().getProvider());
160
161                try {
162                        verifier.initVerify(publicKey);
163
164                } catch (InvalidKeyException e) {
165                        throw new JOSEException("Invalid public RSA key: " + e.getMessage(), e);
166                }
167
168                try {
169                        verifier.update(signedContent);
170                        return verifier.verify(signature.decode());
171
172                } catch (SignatureException e) {
173                        return false;
174                }
175        }
176}