Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Crypto::SecrUser)Contributed Perl DocumenOpenXPKI::Crypto::Secret(3)

Name
       OpenXPKI::Crypto::Secret	- Base class for secrets (e. g.	PINs).

Description
       Base class for secret storage.

       Subclasses must implement the methods set_secret(), get_secret()	and
       is_complete().

       If the secret is	fully known, the subclass must return a	true value
       whenever	is_complete() is called.

       Once the	secret is known	the subclass must return the secret whenever
       get_secret() is called, otherwise an undefined value should be
       returned.

       See OpenXPKI::Crypto::Secret::Plain for a usage example.

   Methods
       new

       Constructor. Select 'Secret' implementation by specifying the named
       parameter 'TYPE'	accordingly. TYPE defaults to 'Plain'.	See
       OpenXPKI::Crypto::Secret::Plain.

       is_complete

       Returns true once the secret is known.  Must be implemented by
       subclasses.

       is_exportable

       If this secret value should be exposed outside the crypto manager.

       get_secret

       Returns the resulting secret or undef if	not yet	available.  Must be
       implemented by subclasses.

       set_secret

       Sets (part of) the secret.  Must	be implemented by subclasses.

perl v5.24.1			  2017-07-03	   OpenXPKI::Crypto::Secret(3)

Name | Description

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Crypto::Secret&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help