| <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>AesCipherService.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Apache Shiro :: Test Coverage</a> > <a href="../index.html" class="el_bundle">shiro-crypto-cipher</a> > <a href="index.source.html" class="el_package">org.apache.shiro.crypto</a> > <span class="el_source">AesCipherService.java</span></div><h1>AesCipherService.java</h1><pre class="source lang-java linenums">/* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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 org.apache.shiro.crypto; |
| |
| import javax.crypto.spec.GCMParameterSpec; |
| import java.security.spec.AlgorithmParameterSpec; |
| |
| /** |
| * {@code CipherService} using the {@code AES} cipher algorithm for all encryption, decryption, and key operations. |
| * <p/> |
| * The AES algorithm can support key sizes of {@code 128}, {@code 192} and {@code 256} bits<b>*</b>. This implementation |
| * defaults to 128 bits. |
| * <p/> |
| * Note that this class retains changes the parent class's default {@link OperationMode#CBC CBC} mode to {@link OperationMode#GCM GCM} of operation |
| * instead of the typical JDK default of {@link OperationMode#ECB ECB}. {@code ECB} should not be used in |
| * security-sensitive environments because {@code ECB} does not allow for initialization vectors, which are |
| * considered necessary for strong encryption. See the {@link DefaultBlockCipherService parent class}'s JavaDoc and the |
| * {@link JcaCipherService JcaCipherService} JavaDoc for more on why the JDK default should not be used and is not |
| * used in this implementation. |
| * <p/> |
| * <b>*</b> Generating and using AES key sizes greater than 128 require installation of the |
| * <a href="http://java.sun.com/javase/downloads/index.jsp">Java Cryptography Extension (JCE) Unlimited Strength |
| * Jurisdiction Policy files</a>. |
| * |
| * @since 1.0 |
| */ |
| public class AesCipherService extends DefaultBlockCipherService { |
| |
| private static final String ALGORITHM_NAME = "AES"; |
| |
| /** |
| * Creates a new {@link CipherService} instance using the {@code AES} cipher algorithm with the following |
| * important cipher default attributes: |
| * <table> |
| * <tr> |
| * <th>Attribute</th> |
| * <th>Value</th> |
| * </tr> |
| * <tr> |
| * <td>{@link #setKeySize keySize}</td> |
| * <td>{@code 128} bits</td> |
| * </tr> |
| * <tr> |
| * <td>{@link #setBlockSize blockSize}</td> |
| * <td>{@code 128} bits (required for {@code AES}</td> |
| * </tr> |
| * <tr> |
| * <td>{@link #setMode mode}</td> |
| * <td>{@link OperationMode#GCM GCM}<b>*</b></td> |
| * </tr> |
| * <tr> |
| * <td>{@link #setPaddingScheme paddingScheme}</td> |
| * <td>{@link PaddingScheme#PKCS5 PKCS5}</td> |
| * </tr> |
| * <tr> |
| * <td>{@link #setInitializationVectorSize(int) initializationVectorSize}</td> |
| * <td>{@code 128} bits</td> |
| * </tr> |
| * <tr> |
| * <td>{@link #setGenerateInitializationVectors(boolean) generateInitializationVectors}</td> |
| * <td>{@code true}<b>**</b></td> |
| * </tr> |
| * </table> |
| * <p/> |
| * <b>*</b> The {@link OperationMode#GCM GCM} operation mode is used instead of the JDK default {@code ECB} to |
| * ensure strong encryption. {@code ECB} should not be used in security-sensitive environments - see the |
| * {@link DefaultBlockCipherService DefaultBlockCipherService} class JavaDoc's &quot;Operation Mode&quot; section |
| * for more. |
| * <p/> |
| * <b>**</b>In conjunction with the default {@code GCM} operation mode, initialization vectors are generated by |
| * default to ensure strong encryption. See the {@link JcaCipherService JcaCipherService} class JavaDoc for more. |
| */ |
| public AesCipherService() { |
| <span class="fc" id="L90"> super(ALGORITHM_NAME);</span> |
| <span class="fc" id="L91"> setMode(OperationMode.GCM);</span> |
| <span class="fc" id="L92"> setStreamingMode(OperationMode.GCM);</span> |
| <span class="fc" id="L93"> }</span> |
| |
| @Override |
| protected AlgorithmParameterSpec createParameterSpec(byte[] iv, boolean streaming) { |
| |
| <span class="pc bpc" id="L98" title="2 of 6 branches missed."> if ((streaming && OperationMode.GCM.name().equals(getStreamingModeName()))</span> |
| <span class="fc bfc" id="L99" title="All 2 branches covered."> || (!streaming && OperationMode.GCM.name().equals(getModeName()))) {</span> |
| <span class="fc" id="L100"> return new GCMParameterSpec(getKeySize(), iv);</span> |
| } |
| |
| <span class="fc" id="L103"> return super.createParameterSpec(iv, streaming);</span> |
| } |
| } |
| </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.3.201901230119</span></div></body></html> |
