PHP Classes

File: src/Types/LocalPW.php

Recommend this page to a friend!
  Classes of Scott Arciszewski   PASERK PHP   src/Types/LocalPW.php   Download  
File: src/Types/LocalPW.php
Role: Class source
Content type: text/plain
Description: Class source
Class: PASERK PHP
Extend PASETO to wrap and serialize keys
Author: By
Last change:
Date: 1 year ago
Size: 3,261 bytes
 

Contents

Class file image Download
<?php
declare(strict_types=1);
namespace
ParagonIE\Paserk\Types;

use
ParagonIE\HiddenString\HiddenString;
use
ParagonIE\Paserk\{
   
ConstraintTrait,
   
Operations\PBKW,
   
PaserkException,
   
PaserkTypeInterface,
   
Util
};
use
ParagonIE\Paseto\{
   
Exception\InvalidVersionException,
   
KeyInterface,
   
Keys\SymmetricKey,
   
ProtocolCollection,
   
ProtocolInterface
};
use
SodiumException;
use function
   
array_key_exists,
   
explode;

/**
 * Class LocalPW
 * @package ParagonIE\Paserk\Types
 */
class LocalPW implements PaserkTypeInterface
{
    use
ConstraintTrait;

   
/** @var array<string, string> */
   
protected array $localCache = [];

   
/** @var array $options */
   
protected array $options;

   
/** @var HiddenString $password */
   
protected HiddenString $password;

   
/**
     * LocalPW constructor.
     *
     * @param HiddenString $password
     * @param array $options
     * @param ProtocolInterface ...$version
     * @throws InvalidVersionException
     */
   
public function __construct(HiddenString $password, array $options = [], ProtocolInterface ...$version)
    {
       
$this->password = $password;
       
$this->options = $options;
       
$this->localCache = [];
        if (
count($version) > 0) {
           
$this->collection = new ProtocolCollection(...$version);
        } else {
           
$this->collection = ProtocolCollection::v4();
        }
    }

   
/**
     * @param string $paserk
     * @return KeyInterface
     * @throws PaserkException
     */
   
public function decode(string $paserk): KeyInterface
   
{
       
$pieces = explode('.', $paserk);
       
$header = $pieces[0];
       
$version = Util::getPasetoVersion($header);
       
$this->throwIfInvalidProtocol($version);
       
/// @SPEC DETAIL: Algorithm Lucidity

       
$pbkw = PBKW::forVersion($version);

        return
$pbkw->localPwUnwrap($paserk, $this->password);
    }

   
/**
     * @param KeyInterface $key
     * @return string
     *
     * @throws InvalidVersionException
     * @throws PaserkException
     */
   
public function encode(KeyInterface $key): string
   
{
        if (!(
$key instanceof SymmetricKey)) {
            throw new
PaserkException('Only symmetric keys are allowed here');
        }
       
$this->throwIfInvalidProtocol($key->getProtocol());
       
/// @SPEC DETAIL: Algorithm Lucidity

       
$localId = (new Local($key->getProtocol()))->encode($key);
        if (!
array_key_exists($localId, $this->localCache)) {
           
$this->localCache[$localId] = PBKW::forVersion($key->getProtocol())
                ->
localPwWrap($key, $this->password, $this->options);
        }
        return
$this->localCache[$localId];
    }

   
/**
     * @return string
     */
   
public static function getTypeLabel(): string
   
{
        return
'local-pw';
    }

   
/**
     * Get the lid PASERK for the PASERK representation of this local key.
     *
     * @param KeyInterface $key
     * @return string
     *
     * @throws InvalidVersionException
     * @throws PaserkException
     * @throws SodiumException
     */
   
public function id(KeyInterface $key): string
   
{
        return
Lid::encode(
           
$key->getProtocol(),
           
$this->encode($key)
        );
    }
}