docs

PASERK (PHP Documentation)

PASERK is an extension to PASETO that provides key-wrapping and serialization.

To understand the motivation behind PASERK, please refer to the PASERK Specification.

What Is PASERK Anyway?

PASERKs are serialized keys for use with PASETO. PASERK is short for "Platform-Agnostic SERialized Keys".

A serialized key in PASERK has the format:

k[version].[type].[data]

Each PASERK version corresponds directly with the PASETO version a serialized key is intended to be used with, and it MUST NOT be used for another version.

Each PASERK type is a composition of one or more PASERK operations.

Please refer to the PASERK specification if you'd like to learn more about the types/operations.

This section merely focuses on how to use the PHP implementation.

Working with PASERK Types in PHP

• Basic Key Serialization (do NOT store these in a PASETO footer)
  • local
  • public
  • secret
• Canonical Key Identifiers
  • lid
  • pid
  • sid
• Key Wrapping
  • local-wrap
  • local-pw
  • secret-wrap
  • secret-pw
  • seal (Asymmetric Encryption)

For local-wrap and secret-wrap, the key-wrapping protocols this library implements are listed in this directory.

What About the PASERK Operations?

We do not recommend interfacing directly with the PASERK Operations.

Use the PASERK Types instead.