All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nimbusds.jose.crypto.MACVerifier Maven / Gradle / Ivy

Go to download

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 9.47
Show newest version
/*
 * nimbus-jose-jwt
 *
 * Copyright 2012-2016, Connect2id Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.jose.crypto;


import com.nimbusds.jose.CriticalHeaderParamsAware;
import com.nimbusds.jose.JOSEException;
import com.nimbusds.jose.JWSHeader;
import com.nimbusds.jose.JWSVerifier;
import com.nimbusds.jose.crypto.impl.CriticalHeaderParamsDeferral;
import com.nimbusds.jose.crypto.impl.HMAC;
import com.nimbusds.jose.crypto.impl.MACProvider;
import com.nimbusds.jose.crypto.utils.ConstantTimeUtils;
import com.nimbusds.jose.jwk.OctetSequenceKey;
import com.nimbusds.jose.util.Base64URL;
import com.nimbusds.jose.util.StandardCharset;
import net.jcip.annotations.ThreadSafe;

import javax.crypto.SecretKey;
import java.util.Set;


/**
 * Message Authentication Code (MAC) verifier of 
 * {@link com.nimbusds.jose.JWSObject JWS objects}. Expects a secret key.
 *
 * 

See RFC 7518 * section 3.2 * for more information. * *

This class is thread-safe. * *

Supports the following algorithms: * *

    *
  • {@link com.nimbusds.jose.JWSAlgorithm#HS256} *
  • {@link com.nimbusds.jose.JWSAlgorithm#HS384} *
  • {@link com.nimbusds.jose.JWSAlgorithm#HS512} *
*

Tested with the AWS CloudHSM JCE provider. * * @author Vladimir Dzhuvinov * @version 2016-06-26 */ @ThreadSafe public class MACVerifier extends MACProvider implements JWSVerifier, CriticalHeaderParamsAware { /** * The critical header policy. */ private final CriticalHeaderParamsDeferral critPolicy = new CriticalHeaderParamsDeferral(); /** * Creates a new Message Authentication (MAC) verifier. * * @param secret The secret. Must be at least 256 bits long and not * {@code null}. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final byte[] secret) throws JOSEException { this(secret, null); } /** * Creates a new Message Authentication (MAC) verifier. * * @param secretString The secret as a UTF-8 encoded string. Must be at * least 256 bits long and not {@code null}. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final String secretString) throws JOSEException { this(secretString.getBytes(StandardCharset.UTF_8)); } /** * Creates a new Message Authentication (MAC) verifier. * * @param secretKey The secret key. Must be at least 256 bits long and * not {@code null}. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final SecretKey secretKey) throws JOSEException { this(secretKey, null); } /** * Creates a new Message Authentication (MAC) verifier. * * @param jwk The secret as a JWK. Must be at least 256 bits long and * not {@code null}. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final OctetSequenceKey jwk) throws JOSEException { this(jwk.toByteArray()); } /** * Creates a new Message Authentication (MAC) verifier. * * @param secret The secret. Must be at least 256 bits long * and not {@code null}. * @param defCritHeaders The names of the critical header parameters * that are deferred to the application for * processing, empty set or {@code null} if none. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final byte[] secret, final Set defCritHeaders) throws JOSEException { super(secret, SUPPORTED_ALGORITHMS); critPolicy.setDeferredCriticalHeaderParams(defCritHeaders); } /** * Creates a new Message Authentication (MAC) verifier. * * @param secretKey The secret key. Must be at least 256 bits long * and not {@code null}. * @param defCritHeaders The names of the critical header parameters * that are deferred to the application for * processing, empty set or {@code null} if none. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final SecretKey secretKey, final Set defCritHeaders) throws JOSEException { super(secretKey, SUPPORTED_ALGORITHMS); critPolicy.setDeferredCriticalHeaderParams(defCritHeaders); } /** * Creates a new Message Authentication (MAC) verifier. * * @param jwk The secret as a JWK. Must be at least 256 bits * long and not {@code null}. * @param defCritHeaders The names of the critical header parameters * that are deferred to the application for * processing, empty set or {@code null} if none. * * @throws JOSEException If the secret length is shorter than the * minimum 256-bit requirement. */ public MACVerifier(final OctetSequenceKey jwk, final Set defCritHeaders) throws JOSEException { this(jwk.toByteArray(), defCritHeaders); } @Override public Set getProcessedCriticalHeaderParams() { return critPolicy.getProcessedCriticalHeaderParams(); } @Override public Set getDeferredCriticalHeaderParams() { return critPolicy.getProcessedCriticalHeaderParams(); } @Override public boolean verify(final JWSHeader header, final byte[] signedContent, final Base64URL signature) throws JOSEException { if (! critPolicy.headerPasses(header)) { return false; } String jcaAlg = getJCAAlgorithmName(header.getAlgorithm()); byte[] expectedHMAC = HMAC.compute(jcaAlg, getSecretKey(), signedContent, getJCAContext().getProvider()); return ConstantTimeUtils.areEqual(expectedHMAC, signature.decode()); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy