Type Members

1.  final case class AsymmetricEncrypted(ciphertext: ByteString, encryptionAlgorithmSpec: EncryptionAlgorithmSpec, fingerprint: String) extends GeneratedMessage with Updatable[AsymmetricEncrypted] with Product with Serializable
   ciphertext

   Asymmetrically encrypted data

   encryptionAlgorithmSpec

   The asymmetric encryption specification used for the encryption

   fingerprint

   The fingerprint of the public key that was used for the encryption

   Annotations

   @SerialVersionUID()

2.  sealed abstract class CryptoKeyFormat extends GeneratedEnum

   Serialization format for crypto keys and signatures

3.  final case class CryptoKeyPair(pair: Pair) extends GeneratedMessage with Updatable[CryptoKeyPair] with Product with Serializable

   Annotations

   @SerialVersionUID()

4.  sealed abstract class EncryptionAlgorithmSpec extends GeneratedEnum
5.  final case class EncryptionKeyPair(publicKey: Option[EncryptionPublicKey], privateKey: Option[EncryptionPrivateKey]) extends GeneratedMessage with Updatable[EncryptionKeyPair] with Product with Serializable

   Annotations

   @SerialVersionUID()

6.  sealed abstract class EncryptionKeyScheme extends GeneratedEnum

   @deprecated

7.  sealed abstract class EncryptionKeySpec extends GeneratedEnum
8.  final case class EncryptionPrivateKey(id: String, format: CryptoKeyFormat, privateKey: ByteString, scheme: EncryptionKeyScheme, keySpec: EncryptionKeySpec) extends GeneratedMessage with Updatable[EncryptionPrivateKey] with Product with Serializable
   privateKey

   Serialized private key in the format specified above

   scheme

   No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.

   keySpec

   The key specification that was used to generate the key pair

   Annotations

   @SerialVersionUID()

9.  final case class EncryptionPublicKey(format: CryptoKeyFormat, publicKey: ByteString, scheme: EncryptionKeyScheme, keySpec: EncryptionKeySpec) extends GeneratedMessage with Updatable[EncryptionPublicKey] with Product with Serializable
   publicKey

   Serialized public key in the format specified above

   scheme

   No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.

   keySpec

   The key specification that was used to generate the key pair

   Annotations

   @SerialVersionUID()

10.  sealed abstract class HashAlgorithm extends GeneratedEnum
11.  final case class Hmac(algorithm: HmacAlgorithm, hmac: ByteString) extends GeneratedMessage with Updatable[Hmac] with Product with Serializable

    Annotations

    @SerialVersionUID()

12.  sealed abstract class HmacAlgorithm extends GeneratedEnum
13.  sealed abstract class KeyPurpose extends GeneratedEnum
14.  final case class PasswordBasedEncrypted(ciphertext: ByteString, symmetricKeyScheme: SymmetricKeyScheme, pbkdfScheme: PbkdfScheme, salt: ByteString) extends GeneratedMessage with Updatable[PasswordBasedEncrypted] with Product with Serializable

    A password-based encrypted message

    A password-based encrypted message

    symmetricKeyScheme

    The symmetric encryption scheme that was used to encrypt the plaintext

    pbkdfScheme

    The password-based KDF that was used to derive the symmetric encryption key from the password

    salt

    The random salt that was used to derive the symmetric encryption key from the password

    Annotations

    @SerialVersionUID()

15.  sealed abstract class PbkdfScheme extends GeneratedEnum
16.  final case class PrivateKey(key: Key) extends GeneratedMessage with Updatable[PrivateKey] with Product with Serializable

    Annotations

    @SerialVersionUID()

17.  final case class PublicKey(key: Key) extends GeneratedMessage with Updatable[PublicKey] with Product with Serializable

    Annotations

    @SerialVersionUID()

18.  final case class PublicKeyWithName(publicKey: Option[PublicKey], name: String) extends GeneratedMessage with Updatable[PublicKeyWithName] with Product with Serializable
    name

    Optional name of the public key

    Annotations

    @SerialVersionUID()

19.  final case class RequiredEncryptionSpecs(algorithms: Seq[EncryptionAlgorithmSpec], keys: Seq[EncryptionKeySpec]) extends GeneratedMessage with Updatable[RequiredEncryptionSpecs] with Product with Serializable

    Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

    Used to announce the required encryption key and algorithm specifications in the static synchronizer parameters.

    Annotations

    @SerialVersionUID()

20.  final case class RequiredSigningSpecs(algorithms: Seq[SigningAlgorithmSpec], keys: Seq[SigningKeySpec]) extends GeneratedMessage with Updatable[RequiredSigningSpecs] with Product with Serializable

    Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

    Used to announce the required signing key and algorithm specifications in the static synchronizer parameters.

    Annotations

    @SerialVersionUID()

21.  final case class Salt(algorithm: Algorithm, salt: ByteString) extends GeneratedMessage with Updatable[Salt] with Product with Serializable

    Annotations

    @SerialVersionUID()

22.  final case class Signature(format: SignatureFormat, signature: ByteString, signedBy: String, signingAlgorithmSpec: SigningAlgorithmSpec, signatureDelegation: Option[SignatureDelegation]) extends GeneratedMessage with Updatable[Signature] with Product with Serializable
    signedBy

    The fingerprint/id of the keypair used to create this signature and needed to verify. If a signature delegation is defined, this fingerprint/id is not used to produce the signature, and, instead is used to sign the delegation.

    signingAlgorithmSpec

    The signing algorithm specification used to produce this signature

    signatureDelegation

    An optional signature delegation where a long-term signing key authorizes a session signing key to sign on its behalf.

    Annotations

    @SerialVersionUID()

23.  final case class SignatureDelegation(sessionKey: ByteString, sessionKeySpec: SigningKeySpec, validityPeriodFromInclusive: Long, validityPeriodDurationSeconds: Int, format: SignatureFormat, signature: ByteString, signingAlgorithmSpec: SigningAlgorithmSpec) extends GeneratedMessage with Updatable[SignatureDelegation] with Product with Serializable
    sessionKey

    ASN.1 + DER-encoding of X.509 SubjectPublicKeyInfo structure of the session public key: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1. This key was used to produce the actual signature.

    sessionKeySpec

    The signing key spec for the session key.

    validityPeriodFromInclusive

    A timestamp in microseconds of UTC time since Unix epoch that indicates when the session key is considered valid.

    validityPeriodDurationSeconds

    Duration in seconds indicating how long the session key remains valid. The validity period starts from validity_period_from_inclusive above.

    format

    The format of the signature

    signature

    The signature of the combined hash of the session key fingerprint, validity period, and synchronizer id, by the long-term key. This signature authorizes the session key to act on behalf of the long-term key.

    signingAlgorithmSpec

    The signing algorithm specification used to produce this signature

    Annotations

    @SerialVersionUID()

24.  sealed abstract class SignatureFormat extends GeneratedEnum
25.  sealed abstract class SigningAlgorithmSpec extends GeneratedEnum
26.  final case class SigningKeyPair(publicKey: Option[SigningPublicKey], privateKey: Option[SigningPrivateKey]) extends GeneratedMessage with Updatable[SigningKeyPair] with Product with Serializable

    Annotations

    @SerialVersionUID()

27.  sealed abstract class SigningKeyScheme extends GeneratedEnum

    @deprecated

28.  sealed abstract class SigningKeySpec extends GeneratedEnum

    [start-docs-entry: signing key spec proto]

29.  sealed abstract class SigningKeyUsage extends GeneratedEnum
30.  final case class SigningPrivateKey(id: String, format: CryptoKeyFormat, privateKey: ByteString, scheme: SigningKeyScheme, usage: Seq[SigningKeyUsage], keySpec: SigningKeySpec) extends GeneratedMessage with Updatable[SigningPrivateKey] with Product with Serializable
    privateKey

    Serialized private key in the format specified above

    scheme

    No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.

    usage

    Explicitly state the key's intended use

    keySpec

    The key specification that was used to generate the key pair

    Annotations

    @SerialVersionUID()

31.  final case class SigningPublicKey(format: CryptoKeyFormat, publicKey: ByteString, scheme: SigningKeyScheme, usage: Seq[SigningKeyUsage], keySpec: SigningKeySpec) extends GeneratedMessage with Updatable[SigningPublicKey] with Product with Serializable
    publicKey

    Serialized public key in the format specified above

    scheme

    No longer used (only kept for backwards compatibility) stores both the crypto key scheme and algorithm.

    usage

    Explicitly state the key's intended use

    keySpec

    The key specification that was used to generate the key pair

    Annotations

    @SerialVersionUID()

32.  final case class SymmetricKey(format: CryptoKeyFormat, key: ByteString, scheme: SymmetricKeyScheme) extends GeneratedMessage with Updatable[SymmetricKey] with Product with Serializable

    Annotations

    @SerialVersionUID()

33.  sealed abstract class SymmetricKeyScheme extends GeneratedEnum