Documentation

PrivateKey extends EC
in package

EC

implements PrivateKey uses PasswordProtected

EC Private Key

Interfaces

PrivateKey: PrivateKey interface

Constants

ALGORITHM = 'EC': Algorithm Name

Properties

$context : string: Context
$curve : Base: Curve
$dA : object: Private Key dA
$engines : array<string|int, bool>: Available Engines
$format : string: Signature Format
$hash : Hash: Hash function
$one : BigInteger: Precomputed One
$q : BigInteger: Curve Order
$QA : array<string|int, object>: Public Key QA
$shortFormat : string: Signature Format (Short)
$x : BigInteger: Alias for the private key
$zero : BigInteger: Precomputed Zero
$comment : null|string: Key Comment
$curveName : string: Curve Name
$hmac : Hash: HMAC function
$invisiblePlugins : array<string|int, mixed>: Invisible plugins
$password : string|bool: Password
$plugins : array<string|int, mixed>: Supported plugins (lower case)
$signatureFileFormats : array<string|int, mixed>: Supported signature formats (original case)
$signatureFormats : array<string|int, mixed>: Supported signature formats (lower case)

Methods

__toString() : string: __toString() magic method
addFileFormat() : bool: Add a fileformat plugin
createKey() : PrivateKey: Create public / private key pair.
getComment() : null|string: Returns the key's comment
getContext() : mixed: Returns the signature format currently being used
getCurve() : string|array<string|int, mixed>: Returns the curve
getEncodedCoordinates() : string: Returns the public key coordinates as a string
getEngine() : string: Returns the current engine being used
getHash() : mixed: Returns the hash algorithm currently being used
getLength() : int: Returns the key size
getLoadedFormat() : mixed: Returns the format of the loaded key.
getParameters() : mixed: Returns the parameters
getPublicKey() : mixed: Returns the public key
getSignatureFormat() : mixed: Returns the signature format currently being used
getSupportedKeyFormats() : array<string|int, mixed>: Returns a list of supported formats.
load() : AsymmetricKey: Load the key
loadFormat() : AsymmetricKey: Load the key, assuming a specific format
loadParameters() : AsymmetricKey: Loads parameters
loadParametersFormat() : AsymmetricKey: Loads parameters
loadPrivateKey() : PrivateKey: Loads a private key
loadPrivateKeyFormat() : PrivateKey: Loads a private key
loadPublicKey() : PublicKey: Loads a public key
loadPublicKeyFormat() : PublicKey: Loads a public key
multiply() : string: Multiplies an encoded point by the private key
sign() : mixed: Create a signature
toString() : string: Returns the private key
useBestEngine() : mixed: Tests engine validity
useInternalEngine() : mixed: Flag to use internal engine only (useful for unit testing)
withContext() : mixed: Sets the context
withHash() : mixed: Determines which hashing function should be used
withPassword() : mixed: Sets the password
withSignatureFormat() : mixed: Determines the signature padding mode
__construct() : mixed: Constructor
bits2int() : BigInteger: Bit String to Integer
computek() : string: Compute the pseudorandom k for signature generation, using the process specified for deterministic DSA.
initialize_static_variables() : mixed: Initialize static variables
onLoad() : bool: OnLoad Handler
validatePlugin() : mixed: Validate Plugin
bits2octets() : string: Bit String to Octet String
int2octets() : string: Integer to Octet String
loadPlugins() : mixed: Load Plugins

ALGORITHM

Algorithm Name


    public
        string
    ALGORITHM
    = 'EC'

$context

Context


    protected
        string
    $context

$curve

Curve


    protected
        Base
    $curve

$dA

Private Key dA


    protected
        object
    $dA

sign() converts this to a BigInteger so one might wonder why this is a FiniteFieldInteger instead of a BigInteger. That's because a FiniteFieldInteger, when converted to a byte string, is null padded by a certain amount whereas a BigInteger isn't.

$engines

Available Engines


    protected
    static    array<string|int, bool>
    $engines
     = []

$format

Signature Format


    protected
        string
    $format

$hash

Hash function


    protected
        Hash
    $hash

$one

Precomputed One


    protected
    static    BigInteger
    $one

$q

Curve Order


    protected
        BigInteger
    $q

Used for deterministic ECDSA

$QA

Public Key QA


    protected
        array<string|int, object>
    $QA

$shortFormat

Signature Format (Short)


    protected
        string
    $shortFormat

$x

Alias for the private key


    protected
        BigInteger
    $x

Used for deterministic ECDSA. AsymmetricKey expects $x. I don't like x because with x you have x * the base point yielding an (x, y)-coordinate that is the public key. But the x is different depending on which side of the equal sign you're on. It's less ambiguous if you do dA * base point = (x, y)-coordinate.

$zero

Precomputed Zero


    protected
    static    BigInteger
    $zero

$comment

Key Comment


    private
        null|string
    $comment

$curveName

Curve Name


    private
        string
    $curveName

$hmac

HMAC function


    private
        Hash
    $hmac

$invisiblePlugins

Invisible plugins


    private
    static    array<string|int, mixed>
    $invisiblePlugins
     = []

$password

Password


    private
        string|bool
    $password
     = false

$plugins

Supported plugins (lower case)


    private
    static    array<string|int, mixed>
    $plugins
     = []

$signatureFileFormats

Supported signature formats (original case)


    private
    static    array<string|int, mixed>
    $signatureFileFormats
     = []

$signatureFormats

Supported signature formats (lower case)


    private
    static    array<string|int, mixed>
    $signatureFormats
     = []

__toString()

__toString() magic method


    public
                    __toString() : string

Return values

string

addFileFormat()

Add a fileformat plugin


    public
            static        addFileFormat(string $fullname) : bool

The plugin needs to either already be loaded or be auto-loadable. Loading a plugin whose shortname overwrite an existing shortname will overwrite the old plugin.

Parameters

$fullname : string

Return values

bool

createKey()

Create public / private key pair.


    public
            static        createKey(string $curve) : PrivateKey

Parameters

$curve : string

Return values

PrivateKey

getComment()

Returns the key's comment


    public
                    getComment() : null|string

Not all key formats support comments. If you want to set a comment use toString()

Return values

null|string

getContext()

Returns the signature format currently being used


    public
                    getContext() : mixed

getCurve()

Returns the curve


    public
                    getCurve() : string|array<string|int, mixed>

Returns a string if it's a named curve, an array if not

Return values

string|array<string|int, mixed>

getEncodedCoordinates()

Returns the public key coordinates as a string


    public
                    getEncodedCoordinates() : string

Used by ECDH

Return values

string

getEngine()

Returns the current engine being used


    public
                    getEngine() : string

Return values

string

getHash()

Returns the hash algorithm currently being used


    public
                    getHash() : mixed

getLength()

Returns the key size


    public
                    getLength() : int

Quoting https://tools.ietf.org/html/rfc5656#section-2,

"The size of a set of elliptic curve domain parameters on a prime curve is defined as the number of bits in the binary representation of the field order, commonly denoted by p. Size on a characteristic-2 curve is defined as the number of bits in the binary representation of the field, commonly denoted by m. A set of elliptic curve domain parameters defines a group of order n generated by a base point P"

Return values

int

getLoadedFormat()

Returns the format of the loaded key.


    public
                    getLoadedFormat() : mixed

If the key that was loaded wasn't in a valid or if the key was auto-generated with RSA::createKey() then this will throw an exception.

getParameters()

Returns the parameters


    public
                    getParameters([string $type = 'PKCS1' ]) : mixed

Parameters

$type : string = 'PKCS1': optional

getPublicKey()

Returns the public key


    public
                    getPublicKey() : mixed

getSignatureFormat()

Returns the signature format currently being used


    public
                    getSignatureFormat() : mixed

getSupportedKeyFormats()

Returns a list of supported formats.


    public
            static        getSupportedKeyFormats() : array<string|int, mixed>

Return values

array<string|int, mixed>

load()

Load the key


    public
            static        load(string $key[, string $password = false ]) : AsymmetricKey

Parameters

$key : string
$password : string = false: optional

Return values

AsymmetricKey

loadFormat()

Load the key, assuming a specific format


    public
            static        loadFormat(string $type, string $key[, string $password = false ]) : AsymmetricKey

Parameters

$type : string
$key : string
$password : string = false: optional

Return values

AsymmetricKey

loadParameters()

Loads parameters


    public
                    loadParameters(string|array<string|int, mixed> $key) : AsymmetricKey

Parameters

$key : string|array<string|int, mixed>

Return values

AsymmetricKey

loadParametersFormat()

Loads parameters


    public
                    loadParametersFormat(string $type, string|array<string|int, mixed> $key) : AsymmetricKey

Parameters

$type : string
$key : string|array<string|int, mixed>

Return values

AsymmetricKey

loadPrivateKey()

Loads a private key


    public
                    loadPrivateKey(string|array<string|int, mixed> $key[, string $password = '' ]) : PrivateKey

Parameters

$key : string|array<string|int, mixed>
$password : string = '': optional

Return values

PrivateKey

loadPrivateKeyFormat()

Loads a private key


    public
                    loadPrivateKeyFormat(string $type, string $key[, string $password = false ]) : PrivateKey

Parameters

$type : string
$key : string
$password : string = false: optional

Return values

PrivateKey

loadPublicKey()

Loads a public key


    public
                    loadPublicKey(string|array<string|int, mixed> $key) : PublicKey

Parameters

$key : string|array<string|int, mixed>

Return values

PublicKey

loadPublicKeyFormat()

Loads a public key


    public
                    loadPublicKeyFormat(string $type, string $key) : PublicKey

Parameters

$type : string
$key : string

Return values

PublicKey

multiply()

Multiplies an encoded point by the private key


    public
                    multiply(string $coordinates) : string

Used by ECDH

Parameters

$coordinates : string

Return values

string

sign()

Create a signature


    public
                    sign(string $message) : mixed

Parameters

$message : string

toString()

Returns the private key


    public
                    toString(string $type[, array<string|int, mixed> $options = [] ]) : string

Parameters

$type : string
$options : array<string|int, mixed> = []: optional

Return values

string

useBestEngine()

Tests engine validity


    public
            static        useBestEngine() : mixed

useInternalEngine()

Flag to use internal engine only (useful for unit testing)


    public
            static        useInternalEngine() : mixed

withContext()

Sets the context


    public
                    withContext([string $context = null ]) : mixed

Used by Ed25519 / Ed448.

Parameters

$context : string = null: optional

withHash()

Determines which hashing function should be used


    public
                    withHash(string $hash) : mixed

Parameters

$hash : string

withPassword()

Sets the password


    public
                    withPassword([string|bool $password = false ]) : mixed

Private keys can be encrypted with a password. To unset the password, pass in the empty string or false. Or rather, pass in $password such that empty($password) && !is_string($password) is true.

Parameters

$password : string|bool = false

withSignatureFormat()

Determines the signature padding mode


    public
                    withSignatureFormat(string $format) : mixed

Valid values are: ASN1, SSH2, Raw

Parameters

$format : string

__construct()

Constructor


    protected
                    __construct() : mixed

PublicKey and PrivateKey objects can only be created from abstract RSA class

bits2int()

Bit String to Integer


    protected
                    bits2int(string $in) : BigInteger

Parameters

$in : string

Return values

BigInteger

computek()

Compute the pseudorandom k for signature generation, using the process specified for deterministic DSA.


    protected
                    computek(string $h1) : string

Parameters

$h1 : string

Return values

string

initialize_static_variables()

Initialize static variables


    protected
            static        initialize_static_variables() : mixed

onLoad()

OnLoad Handler


    protected
            static        onLoad(array<string|int, mixed> $components) : bool

Parameters

$components : array<string|int, mixed>

Return values

bool

validatePlugin()

Validate Plugin


    protected
            static        validatePlugin(string $format, string $type[, string $method = NULL ]) : mixed

Parameters

$format : string
$type : string
$method : string = NULL: optional

bits2octets()

Bit String to Octet String


    private
                    bits2octets(string $in) : string

Parameters

$in : string

Return values

string

int2octets()

Integer to Octet String


    private
                    int2octets(BigInteger $v) : string

Parameters

$v : BigInteger

Return values

string

loadPlugins()

Load Plugins


    private
            static        loadPlugins(string $format) : mixed

Parameters

$format : string

PrivateKey extends EC in package EC implements PrivateKey uses PasswordProtected

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

ALGORITHM

Tags

Properties

$context

$curve

$dA

$engines

Tags

$format

Tags

$hash

Tags

$one

Tags

$q

$QA

$shortFormat

Tags

$x

$zero

Tags

$comment

Tags

$curveName

$hmac

Tags

$invisiblePlugins

Tags

$password

$plugins

Tags

$signatureFileFormats

Tags

$signatureFormats

Tags

Methods

__toString()

Return values

addFileFormat()

Parameters

Tags

Return values

createKey()

Parameters

Tags

Return values

getComment()

Tags

Return values

getContext()

Tags

getCurve()

Tags

Return values

getEncodedCoordinates()

Return values

PrivateKey extends EC
in package

EC

implements PrivateKey uses PasswordProtected