• Home
• ParagonIE
• Halite
• KeyFactory

PHP Class ParagonIE\Halite\KeyFactory

Show file Open project: paragonie/halite Class Usage Examples

Public Methods

Method	Description
deriveAuthenticationKey ( HiddenString $password, string $salt, string $level = self::INTERACTIVE ) : AuthenticationKey	Derive an authentication key (symmetric) from a password and salt
deriveEncryptionKey ( HiddenString $password, string $salt, string $level = self::INTERACTIVE ) : EncryptionKey	Derive an encryption key (symmetric-key cryptography) from a password and salt
deriveEncryptionKeyPair ( HiddenString $password, string $salt, string $level = self::INTERACTIVE ) : EncryptionKeyPair	Derive a key pair for public key encryption from a password and salt
deriveSignatureKeyPair ( HiddenString $password, string $salt, string $level = self::INTERACTIVE ) : SignatureKeyPair	Derive a key pair for public key signatures from a password and salt
export ( $key ) : HiddenString	Export a cryptography key to a string (with a checksum)
generateAuthenticationKey ( string &$secretKey = '' ) : AuthenticationKey	Generate an an authentication key (symmetric-key cryptography)
generateEncryptionKey ( string &$secretKey = '' ) : EncryptionKey	Generate an an encryption key (symmetric-key cryptography)
generateEncryptionKeyPair ( string &$secretKey = '' ) : EncryptionKeyPair	Generate a key pair for public key encryption
generateSignatureKeyPair ( string &$secretKey = '' ) : SignatureKeyPair	Generate a key pair for public key digital signatures
getKeyDataFromString ( string $data ) : string	Take a stored key string, get the derived key (after verifying the checksum)
getSecurityLevels ( string $level = self::INTERACTIVE ) : array	Returns a 2D array [OPSLIMIT, MEMLIMIT] for the appropriate security level.
importAuthenticationKey ( HiddenString $keyData ) : AuthenticationKey	Load a symmetric authentication key from a string
importEncryptionKey ( HiddenString $keyData ) : EncryptionKey	Load a symmetric encryption key from a string
importEncryptionKeyPair ( HiddenString $keyData ) : EncryptionKeyPair	Load an asymmetric encryption key pair from a string
importEncryptionPublicKey ( HiddenString $keyData ) : EncryptionPublicKey	Load, specifically, an encryption public key from a string
importEncryptionSecretKey ( HiddenString $keyData ) : EncryptionSecretKey	Load, specifically, an encryption secret key from a string
importSignatureKeyPair ( HiddenString $keyData ) : SignatureKeyPair	Load an asymmetric signature key pair from a string
importSignaturePublicKey ( HiddenString $keyData ) : SignaturePublicKey	Load, specifically, a signature public key from a string
importSignatureSecretKey ( HiddenString $keyData ) : SignatureSecretKey	Load, specifically, a signature secret key from a string
loadAuthenticationKey ( string $filePath ) : AuthenticationKey	Load a symmetric authentication key from a file
loadEncryptionKey ( string $filePath ) : EncryptionKey	Load a symmetric encryption key from a file
loadEncryptionKeyPair ( string $filePath ) : EncryptionKeyPair	Load an asymmetric encryption key pair from a file
loadEncryptionPublicKey ( string $filePath ) : EncryptionPublicKey	Load, specifically, an encryption public key from a file
loadEncryptionSecretKey ( string $filePath ) : EncryptionSecretKey	Load, specifically, an encryption public key from a file
loadSignatureKeyPair ( string $filePath ) : SignatureKeyPair	Load an asymmetric signature key pair from a file
loadSignaturePublicKey ( string $filePath ) : SignaturePublicKey	Load, specifically, a signature public key from a file
loadSignatureSecretKey ( string $filePath ) : SignatureSecretKey	Load, specifically, a signature secret key from a file
save ( Key | KeyPair $key, string $filename = '' ) : boolean	Save a key to a file

Protected Methods

Method	Description
loadKeyFile ( string $filePath ) : HiddenString	Read a key from a file, verify its checksum
saveKeyFile ( string $filePath, string $keyData ) : boolean	Save a key to a file

Method Details