1. trait
  2. Andromeda
  3. \
  4. Apps
  5. \
  6. Accounts
  7. \
  8. FieldCrypt

FieldCrypt

trait FieldCrypt

Trait allowing objects to store fields encrypted with an account's crypto

The encryption uses the owner account's secret-key crypto (only accessible by them)

Properties

private $crypto_cache

Stores fields decrypted in memory

Methods

static array
getEncryptedFields()

Returns the list of fields encrypted in this object

Account|null
GetAccount()

Returns the account that owns this object

static array
LoadByAccount(ObjectDatabase $database, Account $account)

Returns all objects owned by the given account

static array
GetFieldCryptFieldTemplate()

Gets the extra DB fields required for this trait

bool
isFieldEncrypted($field)

Returns true if the given DB field is encrypted

bool
isCryptoAvailable()

Returns true if field crypto is unlockable

string
GetEncryptedScalar(string $field)

Decrypts and returns the value of the given field

Account
RequireCrypto()

Unlocks account crypto for usage and returns it

string|null
TryGetEncryptedScalar(string $field)

Decrypts and returns the value of the given field

FieldCrypt
SetEncryptedScalar(string $field, string|null $value, bool|null $fieldcrypt = null)

Sets the value of the given field

FieldCrypt
SetEncrypted(bool $crypt)

Sets the crypto state of all stored fields

static void
DecryptAccount(ObjectDatabase $database, Account $account)

Loads any objects for the given account and decrypts their fields

Details

at line 19
abstract static protected array getEncryptedFields()

Returns the list of fields encrypted in this object

Return Value

array

at line 22
abstract protected Account|null GetAccount()

Returns the account that owns this object

Return Value

Account|null

at line 25
abstract static array LoadByAccount(ObjectDatabase $database, Account $account)

Returns all objects owned by the given account

Parameters

ObjectDatabase $database
Account $account

Return Value

array

at line 28
static array GetFieldCryptFieldTemplate()

Gets the extra DB fields required for this trait

Return Value

array

at line 35
protected bool isFieldEncrypted($field)

Returns true if the given DB field is encrypted

Parameters

$field

Return Value

bool

at line 39
protected bool isCryptoAvailable()

Returns true if field crypto is unlockable

Return Value

bool

at line 55
protected string GetEncryptedScalar(string $field)

Decrypts and returns the value of the given field

Parameters

string $field

field name

Return Value

string

decrypted value

Exceptions

KeyNotFoundException

if the value is null

See also

FieldCrypt::TryGetEncryptedScalar

at line 63
protected Account RequireCrypto()

Unlocks account crypto for usage and returns it

Return Value

Account

at line 78
protected string|null TryGetEncryptedScalar(string $field)

Decrypts and returns the value of the given field

Parameters

string $field

field name

Return Value

string|null

decrypted value

at line 103
protected FieldCrypt SetEncryptedScalar(string $field, string|null $value, bool|null $fieldcrypt = null)

Sets the value of the given field

Parameters

string $field

field to set
string|null $value

value to set
bool|null $fieldcrypt

if true, encrypt - default current state

Return Value

FieldCrypt

at line 129
protected FieldCrypt SetEncrypted(bool $crypt)

Sets the crypto state of all stored fields

Parameters

bool $crypt

true to encrypted, false if not

Return Value

FieldCrypt

at line 145
static void DecryptAccount(ObjectDatabase $database, Account $account)

Loads any objects for the given account and decrypts their fields

Parameters

ObjectDatabase $database

database reference
Account $account

account to load by

Return Value

void