2021-02-19 19:51:44 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2021 Paul Schaub.
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*
|
|
|
|
* 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.pgpainless.policy;
|
|
|
|
|
|
|
|
import java.util.Arrays;
|
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.List;
|
|
|
|
|
|
|
|
import org.pgpainless.algorithm.HashAlgorithm;
|
|
|
|
import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
|
2021-04-26 13:38:12 +02:00
|
|
|
import org.pgpainless.util.NotationRegistry;
|
2021-02-19 19:51:44 +01:00
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Policy class used to configure acceptable algorithm suites etc.
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public final class Policy {
|
|
|
|
|
|
|
|
private static Policy INSTANCE;
|
|
|
|
|
|
|
|
private HashAlgorithmPolicy signatureHashAlgorithmPolicy =
|
|
|
|
HashAlgorithmPolicy.defaultSignatureAlgorithmPolicy();
|
|
|
|
private HashAlgorithmPolicy revocationSignatureHashAlgorithmPolicy =
|
|
|
|
HashAlgorithmPolicy.defaultRevocationSignatureHashAlgorithmPolicy();
|
|
|
|
private SymmetricKeyAlgorithmPolicy symmetricKeyAlgorithmPolicy =
|
|
|
|
SymmetricKeyAlgorithmPolicy.defaultSymmetricKeyAlgorithmPolicy();
|
2021-04-26 13:38:12 +02:00
|
|
|
private final NotationRegistry notationRegistry = new NotationRegistry();
|
2021-02-19 19:51:44 +01:00
|
|
|
|
|
|
|
private Policy() {
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the singleton instance of PGPainless' policy.
|
|
|
|
*
|
|
|
|
* @return singleton instance
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public static Policy getInstance() {
|
|
|
|
if (INSTANCE == null) {
|
|
|
|
INSTANCE = new Policy();
|
|
|
|
}
|
|
|
|
return INSTANCE;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the hash algorithm policy for signatures.
|
|
|
|
* @return hash algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public HashAlgorithmPolicy getSignatureHashAlgorithmPolicy() {
|
|
|
|
return signatureHashAlgorithmPolicy;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Set a custom hash algorithm policy for signatures.
|
|
|
|
*
|
|
|
|
* @param policy custom policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public void setSignatureHashAlgorithmPolicy(HashAlgorithmPolicy policy) {
|
|
|
|
if (policy == null) {
|
|
|
|
throw new NullPointerException("Policy cannot be null.");
|
|
|
|
}
|
|
|
|
this.signatureHashAlgorithmPolicy = policy;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the hash algorithm policy for revocations.
|
|
|
|
* This policy is separate from {@link #getSignatureHashAlgorithmPolicy()}, as PGPainless by default uses a
|
|
|
|
* less strict policy when it comes to acceptable algorithms.
|
|
|
|
*
|
|
|
|
* @return revocation signature hash algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public HashAlgorithmPolicy getRevocationSignatureHashAlgorithmPolicy() {
|
|
|
|
return revocationSignatureHashAlgorithmPolicy;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Set a custom hash algorithm policy for revocations.
|
|
|
|
*
|
|
|
|
* @param policy custom policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public void setRevocationSignatureHashAlgorithmPolicy(HashAlgorithmPolicy policy) {
|
|
|
|
if (policy == null) {
|
|
|
|
throw new NullPointerException("Policy cannot be null.");
|
|
|
|
}
|
|
|
|
this.revocationSignatureHashAlgorithmPolicy = policy;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the symmetric encryption algorithm policy.
|
|
|
|
* This policy defines which symmetric algorithms are acceptable.
|
|
|
|
*
|
|
|
|
* @return symmetric algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public SymmetricKeyAlgorithmPolicy getSymmetricKeyAlgorithmPolicy() {
|
|
|
|
return symmetricKeyAlgorithmPolicy;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Set a custom symmetric encryption algorithm policy.
|
|
|
|
*
|
|
|
|
* @param policy custom policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public void setSymmetricKeyAlgorithmPolicy(SymmetricKeyAlgorithmPolicy policy) {
|
|
|
|
if (policy == null) {
|
|
|
|
throw new NullPointerException("Policy cannot be null.");
|
|
|
|
}
|
|
|
|
this.symmetricKeyAlgorithmPolicy = policy;
|
|
|
|
}
|
|
|
|
|
|
|
|
public static final class SymmetricKeyAlgorithmPolicy {
|
|
|
|
|
|
|
|
private final SymmetricKeyAlgorithm defaultSymmetricKeyAlgorithm;
|
|
|
|
private final List<SymmetricKeyAlgorithm> acceptableSymmetricKeyAlgorithms;
|
|
|
|
|
|
|
|
public SymmetricKeyAlgorithmPolicy(SymmetricKeyAlgorithm defaultSymmetricKeyAlgorithm, List<SymmetricKeyAlgorithm> acceptableSymmetricKeyAlgorithms) {
|
|
|
|
this.defaultSymmetricKeyAlgorithm = defaultSymmetricKeyAlgorithm;
|
|
|
|
this.acceptableSymmetricKeyAlgorithms = Collections.unmodifiableList(acceptableSymmetricKeyAlgorithms);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the default symmetric key algorithm.
|
|
|
|
* This algorithm is used as a fallback when no consensus about symmetric algorithms can be reached.
|
|
|
|
*
|
|
|
|
* @return default symmetric encryption algorithm
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public SymmetricKeyAlgorithm getDefaultSymmetricKeyAlgorithm() {
|
|
|
|
return defaultSymmetricKeyAlgorithm;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return true if the given symmetric encryption algorithm is acceptable by this policy.
|
|
|
|
*
|
|
|
|
* @param algorithm algorithm
|
|
|
|
* @return true if algorithm is acceptable, false otherwise
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public boolean isAcceptable(SymmetricKeyAlgorithm algorithm) {
|
|
|
|
return acceptableSymmetricKeyAlgorithms.contains(algorithm);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return true if the given symmetric encryption algorithm is acceptable by this policy.
|
|
|
|
*
|
|
|
|
* @param algorithmId algorithm
|
|
|
|
* @return true if algorithm is acceptable, false otherwise
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public boolean isAcceptable(int algorithmId) {
|
|
|
|
SymmetricKeyAlgorithm algorithm = SymmetricKeyAlgorithm.fromId(algorithmId);
|
|
|
|
return isAcceptable(algorithm);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* The default symmetric encryption algorithm policy of PGPainless.
|
|
|
|
*
|
|
|
|
* @return default symmetric encryption algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public static SymmetricKeyAlgorithmPolicy defaultSymmetricKeyAlgorithmPolicy() {
|
|
|
|
return new SymmetricKeyAlgorithmPolicy(SymmetricKeyAlgorithm.AES_256, Arrays.asList(
|
|
|
|
SymmetricKeyAlgorithm.IDEA,
|
|
|
|
SymmetricKeyAlgorithm.CAST5,
|
|
|
|
SymmetricKeyAlgorithm.BLOWFISH,
|
|
|
|
SymmetricKeyAlgorithm.AES_128,
|
|
|
|
SymmetricKeyAlgorithm.AES_192,
|
|
|
|
SymmetricKeyAlgorithm.AES_256,
|
|
|
|
SymmetricKeyAlgorithm.TWOFISH,
|
|
|
|
SymmetricKeyAlgorithm.CAMELLIA_128,
|
|
|
|
SymmetricKeyAlgorithm.CAMELLIA_192,
|
|
|
|
SymmetricKeyAlgorithm.CAMELLIA_256
|
|
|
|
));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public static final class HashAlgorithmPolicy {
|
|
|
|
|
|
|
|
private final HashAlgorithm defaultHashAlgorithm;
|
|
|
|
private final List<HashAlgorithm> acceptableHashAlgorithms;
|
|
|
|
|
|
|
|
public HashAlgorithmPolicy(HashAlgorithm defaultHashAlgorithm, List<HashAlgorithm> acceptableHashAlgorithms) {
|
|
|
|
this.defaultHashAlgorithm = defaultHashAlgorithm;
|
|
|
|
this.acceptableHashAlgorithms = Collections.unmodifiableList(acceptableHashAlgorithms);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the default hash algorithm.
|
|
|
|
* This algorithm is used as a fallback when no consensus about hash algorithms can be reached.
|
|
|
|
*
|
|
|
|
* @return default hash algorithm
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public HashAlgorithm defaultHashAlgorithm() {
|
|
|
|
return defaultHashAlgorithm;
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return true if the the given hash algorithm is acceptable by this policy.
|
|
|
|
*
|
|
|
|
* @param hashAlgorithm hash algorithm
|
|
|
|
* @return true if the hash algorithm is acceptable, false otherwise
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public boolean isAcceptable(HashAlgorithm hashAlgorithm) {
|
|
|
|
return acceptableHashAlgorithms.contains(hashAlgorithm);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return true if the the given hash algorithm is acceptable by this policy.
|
|
|
|
*
|
|
|
|
* @param algorithmId hash algorithm
|
|
|
|
* @return true if the hash algorithm is acceptable, false otherwise
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public boolean isAcceptable(int algorithmId) {
|
|
|
|
HashAlgorithm algorithm = HashAlgorithm.fromId(algorithmId);
|
|
|
|
return isAcceptable(algorithm);
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* The default signature hash algorithm policy of PGPainless.
|
|
|
|
* Note that this policy is only used for non-revocation signatures.
|
|
|
|
* For revocation signatures {@link #defaultRevocationSignatureHashAlgorithmPolicy()} is used instead.
|
|
|
|
*
|
|
|
|
* @return default signature hash algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public static HashAlgorithmPolicy defaultSignatureAlgorithmPolicy() {
|
|
|
|
return new HashAlgorithmPolicy(HashAlgorithm.SHA512, Arrays.asList(
|
|
|
|
HashAlgorithm.SHA224,
|
|
|
|
HashAlgorithm.SHA256,
|
|
|
|
HashAlgorithm.SHA384,
|
|
|
|
HashAlgorithm.SHA512
|
|
|
|
));
|
|
|
|
}
|
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* The default revocation signature hash algorithm policy of PGPainless.
|
|
|
|
*
|
|
|
|
* @return default revocation signature hash algorithm policy
|
|
|
|
*/
|
2021-02-19 19:51:44 +01:00
|
|
|
public static HashAlgorithmPolicy defaultRevocationSignatureHashAlgorithmPolicy() {
|
|
|
|
return new HashAlgorithmPolicy(HashAlgorithm.SHA512, Arrays.asList(
|
|
|
|
HashAlgorithm.RIPEMD160,
|
|
|
|
HashAlgorithm.SHA1,
|
|
|
|
HashAlgorithm.SHA224,
|
|
|
|
HashAlgorithm.SHA256,
|
|
|
|
HashAlgorithm.SHA384,
|
|
|
|
HashAlgorithm.SHA512
|
|
|
|
));
|
|
|
|
}
|
|
|
|
}
|
2021-04-26 13:38:12 +02:00
|
|
|
|
2021-05-15 20:27:43 +02:00
|
|
|
/**
|
|
|
|
* Return the {@link NotationRegistry} of PGPainless.
|
|
|
|
* The notation registry is used to decide, whether or not a Notation is known or not.
|
|
|
|
* Background: Critical unknown notations render signatures invalid.
|
|
|
|
*
|
|
|
|
* @return Notation registry
|
|
|
|
*/
|
2021-04-26 13:38:12 +02:00
|
|
|
public NotationRegistry getNotationRegistry() {
|
|
|
|
return notationRegistry;
|
|
|
|
}
|
2021-02-19 19:51:44 +01:00
|
|
|
}
|