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 BouncyCastle FIPS provider for the PSxxx family of JWS algorithms.
060 * 
061 * @author Vladimir Dzhuvinov
062 * @version 2015-06-02
063 */
064@ThreadSafe
065public class RSASSAVerifier extends RSASSAProvider implements JWSVerifier, CriticalHeaderParamsAware {
066
067
068        /**
069         * The critical header policy.
070         */
071        private final CriticalHeaderParamsDeferral critPolicy = new CriticalHeaderParamsDeferral();
072
073
074        /**
075         * The public RSA key.
076         */
077        private final RSAPublicKey publicKey;
078
079
080        /**
081         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
082         *
083         * @param publicKey The public RSA key. Must not be {@code null}.
084         */
085        public RSASSAVerifier(final RSAPublicKey publicKey) {
086
087                this(publicKey, null);
088        }
089
090
091        /**
092         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
093         *
094         * @param rsaJWK The RSA JSON Web Key (JWK). Must not be {@code null}.
095         *
096         * @throws JOSEException If the RSA JWK extraction failed.
097         */
098        public RSASSAVerifier(final RSAKey rsaJWK)
099                throws JOSEException {
100
101                this(rsaJWK.toRSAPublicKey(), null);
102        }
103
104
105        /**
106         * Creates a new RSA Signature-Scheme-with-Appendix (RSASSA) verifier.
107         *
108         * @param publicKey      The public RSA key. Must not be {@code null}.
109         * @param defCritHeaders The names of the critical header parameters
110         *                       that are deferred to the application for
111         *                       processing, empty set or {@code null} if none.
112         */
113        public RSASSAVerifier(final RSAPublicKey publicKey,
114                              final Set<String> defCritHeaders) {
115
116                if (publicKey == null) {
117                        throw new IllegalArgumentException("The public RSA key must not be null");
118                }
119
120                this.publicKey = publicKey;
121
122                critPolicy.setDeferredCriticalHeaderParams(defCritHeaders);
123        }
124
125
126        /**
127         * Gets the public RSA key.
128         *
129         * @return The public RSA key.
130         */
131        public RSAPublicKey getPublicKey() {
132
133                return publicKey;
134        }
135
136
137        @Override
138        public Set<String> getProcessedCriticalHeaderParams() {
139
140                return critPolicy.getProcessedCriticalHeaderParams();
141        }
142
143
144        @Override
145        public Set<String> getDeferredCriticalHeaderParams() {
146
147                return critPolicy.getDeferredCriticalHeaderParams();
148        }
149
150
151        @Override
152        public boolean verify(final JWSHeader header,
153                              final byte[] signedContent, 
154                              final Base64URL signature)
155                throws JOSEException {
156
157                if (! critPolicy.headerPasses(header)) {
158                        return false;
159                }
160
161                final Signature verifier = RSASSA.getSignerAndVerifier(header.getAlgorithm(), getJCAContext().getProvider());
162
163                try {
164                        verifier.initVerify(publicKey);
165
166                } catch (InvalidKeyException e) {
167                        throw new JOSEException("Invalid public RSA key: " + e.getMessage(), e);
168                }
169
170                try {
171                        verifier.update(signedContent);
172                        return verifier.verify(signature.decode());
173
174                } catch (SignatureException e) {
175                        return false;
176                }
177        }
178}