/* Copyright 2018 Google LLC
 *
 * 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
 *
 *     https://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.google.security.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.crypto.Cipher;

/**
 * This annotation is used to temporarily disable the InsecureCipherMode Error Prone checker while
 * the violation is being reviewed by ISE. A comment including a tracking bug for the ongoing
 * security review should accompany the annotation. If the specific use is deemed a valid exception
 * after review, the annotation should be changed to @SuppressInsecureCipherModeCheckerReviewed.
 *
 * <p>A {@link Cipher} object is created using one of the overloads of the
 * {@link Cipher#getInstance()} method. This method takes a specification of the transformer either
 * as a triple "Algorithm/Mode/Padding"  or just "Algorithm", using the provider's default settings.
 * The InsecureCipherMode checker implemented in Error Prone flags all call sites of
 * {@link Cipher#getInstance()}, where either the insecure ECB mode or the provider's default mode
 * is used. This method annotation is used to suppress the Error Prone checker in use cases where an
 * exception has been granted by ISE after proper review. The annotation is BUILD-visibility
 * restricted and every use must be vetted by the ISE team.
 *
 * <p>Example of usage:
 * <pre>
 * {@code
 * @SuppressInsecureCipherModeCheckerPendingReview // Tracking bug for the review: b/...
 * private String decrypt(String[] input) {
 * Cipher aesCipher = Cipher.getInstance("AES");
 * aesCipher.init(Cipher.DECRYPT_MODE, new SecretKeySpec(rawKeyMaterial, "AES"));
 * // ...
 * }
 * }
 * </pre>
 *
 * @author avenet@google.com (Arnaud J. Venet)
 *
 */
@Documented
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR,
    ElementType.LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressInsecureCipherModeCheckerPendingReview {}