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; 019 020 021/** 022 * JSON Web Encryption (JWE) encrypter. 023 * 024 * @author Vladimir Dzhuvinov 025 * @author Egor Puzanov 026 * @version 2023-03-26 027 */ 028public interface JWEEncrypter extends JWEProvider { 029 030 031 /** 032 * Encrypts the specified clear text of a {@link JWEObject JWE object}. 033 * 034 * @param header The JSON Web Encryption (JWE) header. Must specify 035 * a supported JWE algorithm and method. Must not be 036 * {@code null}. 037 * @param clearText The clear text to encrypt. Must not be {@code null}. 038 * @param aad The additional authenticated data. Must not be 039 * {@code null}. 040 * 041 * @return The resulting JWE crypto parts. 042 * 043 * @throws JOSEException If the JWE algorithm or method is not 044 * supported or if encryption failed for some 045 * other internal reason. 046 */ 047 JWECryptoParts encrypt(final JWEHeader header, final byte[] clearText, final byte[] aad) 048 throws JOSEException; 049}