PHP Class Airship\Engine\Keyggdrasil\TreeUpdate

This represents an update to Keyggdrasil
Show file Open project: paragonie/airship

Protected Properties

Property Type Description
$channelId integer
$channelName string
$checksum string
$isNewSupplier boolean
$keyType string
$masterSig string | null
$merkleRoot string
$newPublicKey string
$packageType string
$stored array
$supplier Supplier
$supplierMasterKeyUsed SignaturePublicKey
$supplierName string
$updateMessage array
$verified boolean

Public Methods

Method Description
__construct ( Channel $chan, array $updateData ) TreeUpdate constructor.
getChannelId ( ) : integer The upstream primary key for this update
getChannelName ( ) : string
getKeyType ( ) : string
getNodeData ( ) : array
getNodeJSON ( ) : string
getPackageName ( ) : string What is the name of this package?
getPackageType ( ) : string What type of package is this? Possible values: Core, Cabin, Motif, or Gadget.
getPublicKeyObject ( ) : SignaturePublicKey Get the new public key as a SignaturePublicKey object
getPublicKeyString ( ) : string Get the new public key as a hex-coded string
getRoot ( ) : string Get the Merkle root for this update
getSupplier ( ) : Supplier
getSupplierName ( ) : string
isAirshipUpdate ( ) : boolean Is this an update to the Airship core?
isCreateKey ( ) : boolean Is this a "create key" update?
isPackageUpdate ( ) : boolean Is this a "package release" update?
isRevokeKey ( ) : boolean Is this a "revoke key" update?

Protected Methods

Method Description
loadSupplier ( Channel $chan, array $updateData ) : Supplier Return the appropriate supplier (or create it if it doesn't already exist)
unpackMessageUpdate ( Channel $chan, array $updateData ) : void This method stores the necessary bits of data in this object.

Method Details

__construct() public method

TreeUpdate constructor.
public __construct ( Channel $chan, array $updateData )
$chan Channel
$updateData array

getChannelId() public method

The upstream primary key for this update
public getChannelId ( ) : integer
return integer

getChannelName() public method

public getChannelName ( ) : string
return string

getKeyType() public method

public getKeyType ( ) : string
return string

getNodeData() public method

public getNodeData ( ) : array
return array

getNodeJSON() public method

public getNodeJSON ( ) : string
return string

getPackageName() public method

What is the name of this package?
public getPackageName ( ) : string
return string

getPackageType() public method

What type of package is this? Possible values: Core, Cabin, Motif, or Gadget.
public getPackageType ( ) : string
return string

getPublicKeyObject() public method

Get the new public key as a SignaturePublicKey object
public getPublicKeyObject ( ) : SignaturePublicKey
return SignaturePublicKey

getPublicKeyString() public method

Get the new public key as a hex-coded string
public getPublicKeyString ( ) : string
return string

getRoot() public method

Get the Merkle root for this update
public getRoot ( ) : string
return string

getSupplier() public method

public getSupplier ( ) : Supplier
return Supplier

getSupplierName() public method

public getSupplierName ( ) : string
return string

isAirshipUpdate() public method

Is this an update to the Airship core?
public isAirshipUpdate ( ) : boolean
return boolean

isCreateKey() public method

Is this a "create key" update?
public isCreateKey ( ) : boolean
return boolean

isPackageUpdate() public method

Is this a "package release" update?
public isPackageUpdate ( ) : boolean
return boolean

isRevokeKey() public method

Is this a "revoke key" update?
public isRevokeKey ( ) : boolean
return boolean

loadSupplier() protected method

Return the appropriate supplier (or create it if it doesn't already exist)
protected loadSupplier ( Channel $chan, array $updateData ) : Supplier
$chan Channel
$updateData array
return Supplier

unpackMessageUpdate() protected method

This method stores the necessary bits of data in this object.
protected unpackMessageUpdate ( Channel $chan, array $updateData ) : void
$chan Channel
$updateData array
return void

Property Details

$channelId protected property

protected int $channelId
return integer

$channelName protected property

protected string $channelName
return string

$checksum protected property

protected string $checksum
return string

$isNewSupplier protected property

protected bool $isNewSupplier
return boolean

$keyType protected property

protected string $keyType
return string

$masterSig protected property

protected string|null $masterSig
return string | null

$merkleRoot protected property

protected string $merkleRoot
return string

$newPublicKey protected property

protected string $newPublicKey
return string

$packageType protected property

protected string $packageType
return string

$stored protected property

protected array $stored
return array

$supplier protected property

protected Supplier $supplier
return Supplier

$supplierMasterKeyUsed protected property

protected SignaturePublicKey $supplierMasterKeyUsed
return SignaturePublicKey

$supplierName protected property

protected string $supplierName
return string

$updateMessage protected property

protected array $updateMessage
return array

$verified protected property

protected bool $verified
return boolean