PHP Class Neos\Flow\Security\Cryptography\FileBasedSimpleKeyService

Mostra file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$hashService HashService
$passwordGenerationLength integer
$passwordHashingStrategy string

Public Methods

Method Description
generateKey ( string $name ) : string Generates a new key & saves it encrypted with a hashing strategy
getKey ( string $name ) : boolean Returns a key by its name
injectSettings ( array $settings ) : void
keyExists ( string $name ) : boolean Checks if a key exists
storeKey ( string $name, string $password ) : void Saves a key encrypted with a hashing strategy

Protected Methods

Method Description
checkKeyName ( string $name ) : string Checks if the given key name is valid amd returns it (unchanged) if yes. Otherwise it throws an exception.
getKeyPathAndFilename ( string $name ) : string Returns the path and filename for the key with the given name.
getPath ( ) : string Helper function to get the base path for key storage.
persistKey ( string $name, string $password ) : void Persists a key to the file system

Method Details

checkKeyName() protected method

Checks if the given key name is valid amd returns it (unchanged) if yes. Otherwise it throws an exception.
protected checkKeyName ( string $name ) : string
$name string
return string

generateKey() public method

Generates a new key & saves it encrypted with a hashing strategy
public generateKey ( string $name ) : string
$name string
return string

getKey() public method

Returns a key by its name
public getKey ( string $name ) : boolean
$name string
return boolean

getKeyPathAndFilename() protected method

Returns the path and filename for the key with the given name.
protected getKeyPathAndFilename ( string $name ) : string
$name string
return string

getPath() protected method

Helper function to get the base path for key storage.
protected getPath ( ) : string
return string

injectSettings() public method

public injectSettings ( array $settings ) : void
$settings array
return void

keyExists() public method

Checks if a key exists
public keyExists ( string $name ) : boolean
$name string
return boolean

persistKey() protected method

Persists a key to the file system
protected persistKey ( string $name, string $password ) : void
$name string
$password string
return void

storeKey() public method

Saves a key encrypted with a hashing strategy
public storeKey ( string $name, string $password ) : void
$name string
$password string
return void

Property Details

$hashService protected_oe property

protected HashService,Neos\Flow\Security\Cryptography $hashService
return HashService

$passwordGenerationLength protected_oe property

protected int $passwordGenerationLength
return integer

$passwordHashingStrategy protected_oe property

protected string $passwordHashingStrategy
return string