File: doc/Classes/Key.md

Recommend this page to a friend!
  Classes of Scott Arciszewski  >  Halite  >  doc/Classes/Key.md  >  Download  
File: doc/Classes/Key.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Halite
Perform cryptography operations with libsodium
Author: By
Last change:
Date: 5 years ago
Size: 2,011 bytes
 

Contents

Class file image Download

Key

Namespace: \ParagonIE\Halite

Constants

Flags:

    const SECRET_KEY       =   1;
    const PUBLIC_KEY       =   2;
    const ENCRYPTION       =   4;
    const SIGNATURE        =   8;
    const ASYMMETRIC       =  16;

Alias Flags:

    const AUTHENTICATION  =   8;

Shortcut flags:

    const CRYPTO_SECRETBOX =  5;
    const CRYPTO_AUTH      =  9;
    const CRYPTO_BOX       = 20;
    const CRYPTO_SIGN      = 24;

Methods

Constructor

Arguments:

* $keyMaterial - Raw binary string represetning the cryptographic key * $public - Set to TRUE if and only if this is a public key (asymmetric only) * $signing - Set to TRUE if and only if this is a signing/MAC key * $asymmetric - Set to TRUE if and only if this is an asymmetric key (private or public)

Example:

// For Symmetric::encrypt()
$enc_secret = new Key(
     str_repeat('A', 32), 
     false,
     false,
     false
);

// For Symmetric::authenticate()
$auth_secret = new Key(
     str_repeat('A', 32), 
     false,
     true,
     false
);

// For Asymmetric::encrypt(), Asymmetric::seal(), etc.
$box_secret = new Key(
     str_repeat('A', 32), 
     true,
     false,
     true
);

// For Asymmetric::sign()
$sign_secret = new Key(
     str_repeat('A', 32), 
     true,
     true,
     true
);

get()

> public get()

Simply returns the raw binary key data.

isAsymmetricKey()

>public isAsymmetricKey()

Returns true if this is a key meant for asymmetric cryptography.

isEncryptionKey()

> public isEncryptionKey()

Returns true if this is a key meant for encryption.

isPublicKey()

> public isPublicKey()

Returns true if this is the public key for a given key-pair.

isSecretKey()

> public isSecretKey()

Returns true if:

  • Symmetric crypto: Always
  • Asymmetric crypto: This is the secret key for a given key-pair.

isSigningKey()

> public isSigningKey()

Returns true if this is a key meant for authentication


For more information send a message to info at phpclasses dot org.