Package org.apache.iceberg.encryption

Enum EncryptionAlgorithm

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EncryptionAlgorithm>
    public enum EncryptionAlgorithm
extends java.lang.Enum<EncryptionAlgorithm>
    Algorithm supported for file encryption.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AES_CTR
      Counter mode (CTR) allows fast encryption with high throughput.
      AES_GCM
      Galois/Counter mode (GCM) combines CTR with the new Galois mode of authentication.
      AES_GCM_CTR
      A combination of GCM and CTR that can be used for file types like Parquet, so that all modules except pages are encrypted by GCM to ensure integrity, and CTR is used for efficient encryption of bulk data.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static EncryptionAlgorithm valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EncryptionAlgorithm[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • AES_CTR

        public static final EncryptionAlgorithm AES_CTR
        Counter mode (CTR) allows fast encryption with high throughput. It is an encryption only cipher and does not ensure content integrity. Inputs to CTR cipher are: 1. encryption key 2. a 16-byte initialization vector (12-byte nonce, 4-byte counter) 3. plaintext data

      • AES_GCM

        public static final EncryptionAlgorithm AES_GCM
        Galois/Counter mode (GCM) combines CTR with the new Galois mode of authentication. It not only ensures data confidentiality, but also ensures data integrity. Inputs to GCM cipher are: 1. encryption key 2. a 12-byte initialization vector 3. additional authenticated data 4. plaintext data

      • AES_GCM_CTR

        public static final EncryptionAlgorithm AES_GCM_CTR
        A combination of GCM and CTR that can be used for file types like Parquet, so that all modules except pages are encrypted by GCM to ensure integrity, and CTR is used for efficient encryption of bulk data. The tradeoff is that attackers would be able to tamper page data encrypted with CTR.

    • Method Detail

      • values

        public static EncryptionAlgorithm[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EncryptionAlgorithm c : EncryptionAlgorithm.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EncryptionAlgorithm valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null