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.proc;
019
020
021import java.security.Key;
022
023import com.nimbusds.jose.JOSEException;
024import com.nimbusds.jose.JWEDecrypter;
025import com.nimbusds.jose.JWEHeader;
026import com.nimbusds.jose.JWEProvider;
027
028
029/**
030 * JSON Web Encryption (JWE) decrypter factory.
031 *
032 * @author Vladimir Dzhuvinov
033 * @version 2015-11-16
034 */
035public interface JWEDecrypterFactory extends JWEProvider {
036
037
038        /**
039         * Creates a new JWE decrypter for the specified header and key.
040         *
041         * @param header The JWE header. Not {@code null}.
042         * @param key    The key intended to verify the JWS message. Not
043         *               {@code null}.
044         *
045         * @return The JWE decrypter.
046         *
047         * @throws JOSEException If the JWE algorithm / encryption method is
048         *                       not supported or the key type or length
049         *                       doesn't match expected for the JWE algorithm.
050         */
051        JWEDecrypter createJWEDecrypter(final JWEHeader header, final Key key)
052                throws JOSEException;
053}