com.amazonaws.encryptionsdk.model.EncryptionMaterials Maven / Gradle / Ivy

Go to download
package com.amazonaws.encryptionsdk.model;

import javax.crypto.SecretKey;
import java.security.PrivateKey;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import com.amazonaws.encryptionsdk.CryptoAlgorithm;
import com.amazonaws.encryptionsdk.MasterKey;

/**
 * Contains the cryptographic materials needed for an encryption operation.
 *
 * @see com.amazonaws.encryptionsdk.CryptoMaterialsManager#getMaterialsForEncrypt(EncryptionMaterialsRequest)
 */
public final class EncryptionMaterials {
    private final CryptoAlgorithm algorithm;
    private final Map encryptionContext;
    private final List encryptedDataKeys;
    private final SecretKey cleartextDataKey;
    private final PrivateKey trailingSignatureKey;
    private final List masterKeys;

    private EncryptionMaterials(Builder b) {
        this.algorithm = b.algorithm;
        this.encryptionContext = b.encryptionContext;
        this.encryptedDataKeys = b.encryptedDataKeys;
        this.cleartextDataKey = b.cleartextDataKey;
        this.trailingSignatureKey = b.trailingSignatureKey;
        this.masterKeys = b.getMasterKeys();
    }

    public Builder toBuilder() {
        return new Builder(this);
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    /**
     * The algorithm to use for this encryption operation. Must match the algorithm in EncryptionMaterialsRequest, if that
     * algorithm was non-null.
     */
    public CryptoAlgorithm getAlgorithm() {
        return algorithm;
    }

    /**
     * The encryption context to use for the encryption operation. Does not need to match the EncryptionMaterialsRequest.
     */
    public Map getEncryptionContext() {
        return encryptionContext;
    }

    /**
     * The KeyBlobs to serialize (in cleartext) into the encrypted message.
     */
    public List getEncryptedDataKeys() {
        return encryptedDataKeys;
    }

    /**
     * The cleartext data key to use for encrypting this message. Note that this is the data key prior to
     * any key derivation required by the crypto algorithm in use.
     */
    public SecretKey getCleartextDataKey() {
        return cleartextDataKey;
    }

    /**
     * The private key to be used to sign the message trailer. Must be present if any only if required by the
     * crypto algorithm, and the key type must likewise match the algorithm in use.
     *
     * Note that it's the {@link com.amazonaws.encryptionsdk.CryptoMaterialsManager}'s responsibility to find a place
     * to put the public key; typically, this will be in the encryption context, to improve cross-compatibility,
     * but this is not a strict requirement.
     */
    public PrivateKey getTrailingSignatureKey() {
        return trailingSignatureKey;
    }

    /**
     * Contains a list of all MasterKeys that could decrypt this message.
     */
    public List getMasterKeys() {
        return masterKeys;
    }

    @Override public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        EncryptionMaterials that = (EncryptionMaterials) o;
        return algorithm == that.algorithm &&
                Objects.equals(encryptionContext, that.encryptionContext) &&
                Objects.equals(encryptedDataKeys, that.encryptedDataKeys) &&
                Objects.equals(cleartextDataKey, that.cleartextDataKey) &&
                Objects.equals(trailingSignatureKey, that.trailingSignatureKey) &&
                Objects.equals(masterKeys, that.masterKeys);
    }

    @Override public int hashCode() {
        return Objects.hash(algorithm, encryptionContext, encryptedDataKeys, cleartextDataKey, trailingSignatureKey,
                            masterKeys);
    }

    public static class Builder {
        private CryptoAlgorithm algorithm;
        private Map encryptionContext = Collections.emptyMap();
        private List encryptedDataKeys = null;
        private SecretKey cleartextDataKey;
        private PrivateKey trailingSignatureKey;
        private List masterKeys = Collections.emptyList();

        private Builder() {}

        private Builder(EncryptionMaterials r) {
            algorithm = r.algorithm;
            encryptionContext = r.encryptionContext;
            encryptedDataKeys = r.encryptedDataKeys;
            cleartextDataKey = r.cleartextDataKey;
            trailingSignatureKey = r.trailingSignatureKey;
            setMasterKeys(r.masterKeys);
        }

        public EncryptionMaterials build() {
            return new EncryptionMaterials(this);
        }

        public CryptoAlgorithm getAlgorithm() {
            return algorithm;
        }

        public Builder setAlgorithm(CryptoAlgorithm algorithm) {
            this.algorithm = algorithm;
            return this;
        }

        public Map getEncryptionContext() {
            return encryptionContext;
        }

        public Builder setEncryptionContext(Map encryptionContext) {
            this.encryptionContext = Collections.unmodifiableMap(new HashMap<>(encryptionContext));
            return this;
        }

        public List getEncryptedDataKeys() {
            return encryptedDataKeys;
        }

        public Builder setEncryptedDataKeys(List encryptedDataKeys) {
            this.encryptedDataKeys = Collections.unmodifiableList(new ArrayList<>(encryptedDataKeys));
            return this;
        }

        public SecretKey getCleartextDataKey() {
            return cleartextDataKey;
        }

        public Builder setCleartextDataKey(SecretKey cleartextDataKey) {
            this.cleartextDataKey = cleartextDataKey;
            return this;
        }

        public PrivateKey getTrailingSignatureKey() {
            return trailingSignatureKey;
        }

        public Builder setTrailingSignatureKey(PrivateKey trailingSignatureKey) {
            this.trailingSignatureKey = trailingSignatureKey;
            return this;
        }

        public List getMasterKeys() {
            return masterKeys;
        }

        public Builder setMasterKeys(List masterKeys) {
            this.masterKeys = Collections.unmodifiableList(new ArrayList<>(masterKeys));
            return this;
        }
    }
}