pgp-engine/ltechnologies.onionphone.pgpshield.engine

Package-level declarations

Types

data class AddSubkeyRequest(val secretKeyRingArmored: ByteArray, val passphrase: CharArray, val subkeyType: SubkeyType, val rsaBits: Int = 3072)

Parameters for adding a subkey to an existing secret key ring.

AlgorithmLabels

object AlgorithmLabels

Maps OpenPGP algorithm tags and key-type enums to display strings.

BcEcKeyPairs

object BcEcKeyPairs

BC lightweight ECDSA and ECDH key pairs on NIST curves.

BcKeyPairs

object BcKeyPairs

BC lightweight generators for Curve25519 and Ed448 family keys.

BouncyCastleProviderHolder

object BouncyCastleProviderHolder

Lazily registers the Bouncy Castle JCA provider on first access.

CertificationType

enum CertificationType : Enum<CertificationType>

OpenPGP certification trust levels. BC 1.79 names differ from the RFC: PERSONA maps to PGPSignature.NO_CERTIFICATION (0x11), GENERIC to PGPSignature.DEFAULT_CERTIFICATION (0x10).

CertifyKeyRequest

data class CertifyKeyRequest(val certifierSecretArmored: ByteArray, val certifierPassphrase: CharArray, val targetPublicArmored: ByteArray, val userId: String, val certificationType: CertificationType = CertificationType.POSITIVE)

Parameters for certifying a user ID on a target public key.

CertifyKeyResult

data class CertifyKeyResult(val certifiedPublicArmored: ByteArray)

Armored public key ring including the new certification.

ChangePassphraseRequest

data class ChangePassphraseRequest(val secretKeyRingArmored: ByteArray, val oldPassphrase: CharArray, val newPassphrase: CharArray)

Parameters for changing the passphrase on a secret key ring.

DecryptRequest

data class DecryptRequest(val ciphertext: ByteArray, val secretKeyRingArmored: ByteArray, val passphrase: CharArray)

Parameters for decrypting an OpenPGP message.

DecryptResult

data class DecryptResult(val plaintext: ByteArray, val fileName: String?, val verified: Boolean, val securityProblems: List<SecurityProblem>)

Result of a successful decryption.

EccCurve

enum EccCurve : Enum<EccCurve>

NIST elliptic curves supported for JCA and BC lightweight key generation.

EncryptRequest

data class EncryptRequest(val plaintext: ByteArray, val recipientKeyRings: List<ByteArray>, val asciiArmor: Boolean = true, val fileName: String = PGPLiteralData.CONSOLE)

Parameters for encrypting a message to OpenPGP recipients.

EncryptResult

data class EncryptResult(val ciphertext: ByteArray)

Encrypted (and optionally armored) OpenPGP message bytes.

GeneratedKeyRing

data class GeneratedKeyRing(val publicArmored: ByteArray, val secretArmored: ByteArray, val masterKeyId: Long)

Result of a successful key ring generation.

GenerateKeyRequest

data class GenerateKeyRequest(val userId: String, val passphrase: CharArray, val algorithmType: KeyAlgorithmType = KeyAlgorithmType.RSA, val rsaBits: Int = 3072)

Parameters for generating a new OpenPGP key ring.

GpgTar

class GpgTar

Encrypts and decrypts multi-file archives wrapped in OpenPGP messages.

GpgTarDecryptRequest

data class GpgTarDecryptRequest(val ciphertext: ByteArray, val secretKeyRingArmored: ByteArray, val passphrase: CharArray)

Decrypt request for a GpgTar-encrypted archive.

GpgTarEncryptRequest

data class GpgTarEncryptRequest(val files: List<NamedFile>, val recipientKeyRings: List<ByteArray>, val asciiArmor: Boolean = true)

Encrypt request: multiple files to one OpenPGP ciphertext.

JcaPlatform

object JcaPlatform

Android-aware JCA key generation and digest providers for OpenPGP.

KeyAlgorithmType

enum KeyAlgorithmType : Enum<KeyAlgorithmType>

Primary key algorithm presets for new OpenPGP key ring generation.

KeyCertifier

class KeyCertifier

Certifies user IDs on third-party OpenPGP public keys.

KeyGenerator

class KeyGenerator

Generates new OpenPGP key rings with master, encryption, and authentication subkeys.

KeyPairFactory

object KeyPairFactory

Factory that produces algorithm-specific signing, encryption, and authentication key pairs.

KeyPassphraseChanger

class KeyPassphraseChanger

Re-encrypts secret key rings with a new passphrase.

KeyRingExporter

object KeyRingExporter

Converts armored secret key rings to armored public key rings.

KeyRingReader

class KeyRingReader

Reads OpenPGP key rings and maps them to KeyRingInfo.

NamedFile

data class NamedFile(val name: String, val data: ByteArray)

A named file entry in a GpgTar archive.

PgpAlgorithmPolicy

object PgpAlgorithmPolicy

Allowed algorithms, defaults, and key-ring validation for OpenPGP operations.

PgpDecryptor

class PgpDecryptor

Decrypts OpenPGP messages and validates integrity protection.

PgpEncryptor

class PgpEncryptor

Encrypts data to OpenPGP public-key recipients.

PgpException

class PgpException(message: String, val securityProblem: SecurityProblem? = null, cause: Throwable? = null) : Exception

General PGP engine failure.

PgpIo

object PgpIo

Size-limited stream copy and read utilities.

PgpOperators

object PgpOperators

Shared operator builders for signing, verification, and secret-key encryption.

PgpSecurityConstants

object PgpSecurityConstants

Cryptographic constants for secret-key packet construction and protection.

PgpSigner

class PgpSigner

Signs messages and produces cleartext or detached OpenPGP signatures.

PgpStreams

object PgpStreams

Utilities for decoding OpenPGP packet streams.

PgpVerifier

class PgpVerifier

Verifies OpenPGP cleartext and detached signatures.

RemoveSubkeyRequest

data class RemoveSubkeyRequest(val secretKeyRingArmored: ByteArray, val subkeyId: Long)

Parameters for removing a subkey from a secret key ring.

RevocationCertApplier

class RevocationCertApplier

Merges armored revocation signatures into public or secret key rings.

RevocationCertGenerator

class RevocationCertGenerator

Generates armored OpenPGP key revocation signatures from a secret key ring.

RevocationCertRequest

data class RevocationCertRequest(val secretKeyRingArmored: ByteArray, val passphrase: CharArray, val reason: Byte = RevocationReasonTags.NO_REASON, val reasonText: String = "")

Parameters for generating a key revocation certificate.

SecureRandomProvider

object SecureRandomProvider

Shared secure random source for key generation and IV/salt creation.

SecurityProblem

enum SecurityProblem : Enum<SecurityProblem>

Structured security problem detected during verify or decrypt operations.

SignRequest

data class SignRequest(val data: ByteArray, val secretKeyRingArmored: ByteArray, val passphrase: CharArray, val cleartext: Boolean = true, val detachedBinary: Boolean = false)

Parameters for signing data with an OpenPGP secret key ring.

SignResult

data class SignResult(val output: ByteArray)

Armored signature output from PgpSigner.sign.

SmartCardPort

interface SmartCardPort

Port for hardware-backed signing and session-key decryption.

SmimeEngine

class SmimeEngine

S/MIME engine stub. All operations throw PgpException until CMS support is implemented.

SubkeyAdder

class SubkeyAdder

Adds a subkey to an existing secret key ring.

SubkeyRemover

class SubkeyRemover

Removes non-master subkeys from OpenPGP secret key rings.

SubkeyType

enum SubkeyType : Enum<SubkeyType>

Subkey kinds that can be added to an existing secret key ring.

SymmetricCipher

class SymmetricCipher

AES-256-GCM cipher with PBKDF2-HMAC-SHA256 key derivation.

SymmetricDecryptRequest

data class SymmetricDecryptRequest(val ciphertext: ByteArray, val password: CharArray)

Ciphertext blob and password for symmetric decryption.

SymmetricEncryptRequest

data class SymmetricEncryptRequest(val plaintext: ByteArray, val password: CharArray)

Plaintext and password for symmetric encryption.

UserIdEditRequest

data class UserIdEditRequest(val secretKeyRingArmored: ByteArray, val passphrase: CharArray, val userId: String)

Parameters for a user ID edit operation on a secret key ring.

UserIdManager

class UserIdManager

Adds, revokes, and reorders user IDs on OpenPGP master keys.

VerifyRequest

data class VerifyRequest(val signedOrDetached: ByteArray, val detachedMessage: ByteArray? = null, val publicKeyRingsArmored: List<ByteArray> = emptyList(), val binaryDocument: Boolean = false)

Input for signature verification.

VerifyResult

data class VerifyResult(val valid: Boolean, val signerKeyId: Long? = null, val message: ByteArray? = null, val error: String? = null)

Outcome of a verification attempt.