File: docs/Internals/CryptographyKey.md

Recommend this page to a friend!
  Classes of Scott Arciszewski  >  sapient  >  docs/Internals/CryptographyKey.md  >  Download  
File: docs/Internals/CryptographyKey.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: sapient
Add a security layer to server to server requests
Author: By
Last change:
Date: 3 years ago
Size: 901 bytes
 

Contents

Class file image Download

Cryptography Keys

Sapient uses data objects to encapsulate cryptography keys to reduce the likelihood of user error.

For example, an X25519 public key and a Salsa20 shared secret key are both 32 byte binary strings, but you wouldn't want to use a public key as your shared secret key.

There are six types of keys:

  • `SealingPublicKey` -> X25519 public key
  • `SealingSecretKey` -> X25519 secret key
  • `SharedAuthenticationKey` -> HMAC-SHA512256 symmetric key
  • `SharedEncryptionKey` -> Salsa20 symmetric key
  • `SigningPublicKey` -> Ed25519 public key
  • `SigningSecretKey` -> Ed25519 secret key

All six key types that inherit from CryptographyKey do not reveal the actual string in stack traces or var_dump(). In order to view a key, you just need to invoke the getString() method. You may optionally pass TRUE to this method if you want raw binary. (It defaults to base64url encoding).


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