| /* ==================================================================== |
| 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.poi.poifs.crypt; |
| |
| import org.apache.poi.util.Removal; |
| |
| /** |
| * Used when checking if a key is valid for a document |
| */ |
| public abstract class EncryptionVerifier implements Cloneable { |
| private byte[] salt; |
| private byte[] encryptedVerifier; |
| private byte[] encryptedVerifierHash; |
| private byte[] encryptedKey; |
| // protected int verifierHashSize; |
| private int spinCount; |
| private CipherAlgorithm cipherAlgorithm; |
| private ChainingMode chainingMode; |
| private HashAlgorithm hashAlgorithm; |
| |
| protected EncryptionVerifier() {} |
| |
| public byte[] getSalt() { |
| return salt; |
| } |
| |
| public byte[] getEncryptedVerifier() { |
| return encryptedVerifier; |
| } |
| |
| public byte[] getEncryptedVerifierHash() { |
| return encryptedVerifierHash; |
| } |
| |
| public int getSpinCount() { |
| return spinCount; |
| } |
| |
| /** |
| * @deprecated POI 3.16 beta 1. use {@link #getChainingMode()} |
| */ |
| @Removal(version="3.18") |
| public int getCipherMode() { |
| return chainingMode.ecmaId; |
| } |
| |
| /** |
| * @deprecated POI 3.16 beta 1. use {@link #getCipherAlgorithm()} |
| */ |
| public int getAlgorithm() { |
| return cipherAlgorithm.ecmaId; |
| } |
| |
| public byte[] getEncryptedKey() { |
| return encryptedKey; |
| } |
| |
| public CipherAlgorithm getCipherAlgorithm() { |
| return cipherAlgorithm; |
| } |
| |
| public HashAlgorithm getHashAlgorithm() { |
| return hashAlgorithm; |
| } |
| |
| public ChainingMode getChainingMode() { |
| return chainingMode; |
| } |
| |
| protected void setSalt(byte[] salt) { |
| this.salt = (salt == null) ? null : salt.clone(); |
| } |
| |
| protected void setEncryptedVerifier(byte[] encryptedVerifier) { |
| this.encryptedVerifier = (encryptedVerifier == null) ? null : encryptedVerifier.clone(); |
| } |
| |
| protected void setEncryptedVerifierHash(byte[] encryptedVerifierHash) { |
| this.encryptedVerifierHash = (encryptedVerifierHash == null) ? null : encryptedVerifierHash.clone(); |
| } |
| |
| protected void setEncryptedKey(byte[] encryptedKey) { |
| this.encryptedKey = (encryptedKey == null) ? null : encryptedKey.clone(); |
| } |
| |
| protected void setSpinCount(int spinCount) { |
| this.spinCount = spinCount; |
| } |
| |
| protected void setCipherAlgorithm(CipherAlgorithm cipherAlgorithm) { |
| this.cipherAlgorithm = cipherAlgorithm; |
| } |
| |
| protected void setChainingMode(ChainingMode chainingMode) { |
| this.chainingMode = chainingMode; |
| } |
| |
| protected void setHashAlgorithm(HashAlgorithm hashAlgorithm) { |
| this.hashAlgorithm = hashAlgorithm; |
| } |
| |
| @Override |
| public EncryptionVerifier clone() throws CloneNotSupportedException { |
| EncryptionVerifier other = (EncryptionVerifier)super.clone(); |
| other.salt = (salt == null) ? null : salt.clone(); |
| other.encryptedVerifier = (encryptedVerifier == null) ? null : encryptedVerifier.clone(); |
| other.encryptedVerifierHash = (encryptedVerifierHash == null) ? null : encryptedVerifierHash.clone(); |
| other.encryptedKey = (encryptedKey == null) ? null : encryptedKey.clone(); |
| return other; |
| } |
| } |