Menu

## sodium.php

2023-03-30 jj5 - these two service locator functions will automatically create appropriate encryption components for each use case. If you want to override with a different implementation you can pass in a new instance, or you can manage construction yourself and access some other way. These functions are how you should ordinarily access this library.

2023-04-04 jj5 - the service locators will default to using the Sodium module. These are the service locators which will be included by default.

##### Tags

link
  https://github.com/jj5/kickass-crypto

### Table of Contents

kickass_round_trip() : IKickassCrypto
  2023-04-05 jj5 - this is the round-trip service locator defined for use by the Sodium module.
kickass_at_rest() : IKickassCrypto
  2023-04-05 jj5 - this is the at-rest service locator defined for use by the Sodium module.

### Functions

#### kickass_round_trip()

sodium.php : 42

2023-04-05 jj5 - this is the round-trip service locator defined for use by the Sodium module.

`kickass_round_trip([IKickassCrypto $set = false ]) : IKickassCrypto`

This component will use the round-trip keys defined for the Sodium module, those keys are defined with the CONFIG_SODIUM_SECRET_CURR configuration constant (required) and the CONFIG_SODIUM_SECRET_PREV configuration constant (optional).

##### Parameters

$set : IKickassCrypto = false

  pass a valid instance to reconfigure the service locator with a new service instance.

##### Tags

throws
  KickassCryptoException

  if the environment is determined to be unsupported during construction.

##### Return values

IKickassCrypto —

the crypto interface.

#### kickass_at_rest()

sodium.php : 71

2023-04-05 jj5 - this is the at-rest service locator defined for use by the Sodium module.

`kickass_at_rest([IKickassCrypto $set = false ]) : IKickassCrypto`

This component will use the at-rest keys defined for the Sodium module, those keys are defined with the CONFIG_SODIUM_SECRET_LIST configuration constant.

##### Parameters

$set : IKickassCrypto = false

  pass a valid instance to reconfigure the service locator with a new service instance.

##### Tags

throws
  KickassCryptoException

  if the environment is determined to be unsupported during construction.

##### Return values

IKickassCrypto —

the crypto interface.

## Search results