view release on metacpan or  search on metacpan

lib/Crypt/PKCS11/CK_PKCS5_PBKD2_PARAMS.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

Crypt::PKCS11::CK_PKCS5_PBKD2_PARAMS - Perl interface to PKCS #11 CK_PKCS5_PBKD2_PARAMS structure

=head1 SYNPOSIS

  use Crypt::PKCS11::CK_PKCS5_PBKD2_PARAMS;
  my $obj = Crypt::PKCS11::CK_PKCS5_PBKD2_PARAMS->new;
  $obj->set...;
  $obj->get...;

=head1 DESCRIPTION

This is the Perl interface for the C structure CK_PKCS5_PBKD2_PARAMS in PKCS #11.
See PKCS #11 documentation for more information about the structure and what it
is used for.

=head1 METHODS

=over 4

=item $obj = Crypt::PKCS11::CK_PKCS5_PBKD2_PARAMS->new

Returns a new Crypt::PKCS11::CK_PKCS5_PBKD2_PARAMS object.

=item $rv = $obj->get_saltSource($saltSource)

Retrieve the value B<saltSource> from the structure into C<$saltSource>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $saltSource = $obj->saltSource

Returns the value B<saltSource> from the structure or undef on error.

=item $rv = $obj->set_saltSource($saltSource)

Set the value B<saltSource> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_pSaltSourceData($pSaltSourceData)

Retrieve the value B<pSaltSourceData> from the structure into C<$pSaltSourceData>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $pSaltSourceData = $obj->pSaltSourceData

Returns the value B<pSaltSourceData> from the structure or undef on error.

=item $rv = $obj->set_pSaltSourceData($pSaltSourceData)

Set the value B<pSaltSourceData> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_iterations($iterations)

Retrieve the value B<iterations> from the structure into C<$iterations>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $iterations = $obj->iterations

Returns the value B<iterations> from the structure or undef on error.

=item $rv = $obj->set_iterations($iterations)

Set the value B<iterations> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_prf($prf)

Retrieve the value B<prf> from the structure into C<$prf>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $prf = $obj->prf

Returns the value B<prf> from the structure or undef on error.

=item $rv = $obj->set_prf($prf)

Set the value B<prf> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_pPrfData($pPrfData)

Retrieve the value B<pPrfData> from the structure into C<$pPrfData>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $pPrfData = $obj->pPrfData

Returns the value B<pPrfData> from the structure or undef on error.

=item $rv = $obj->set_pPrfData($pPrfData)

Set the value B<pPrfData> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_pPassword($pPassword)

Retrieve the value B<pPassword> from the structure into C<$pPassword>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $pPassword = $obj->pPassword

Returns the value B<pPassword> from the structure or undef on error.

=item $rv = $obj->set_pPassword($pPassword)

Set the value B<pPassword> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=back

=head1 PRIVATE METHODS

These are the private methods used within the module and should not be used
elsewhere.

=over 4

=item $bytes = $obj->toBytes

Return the structure represented as bytes or undef on error.

=item $rv = $obj->fromBytes($bytes)

Sets the structure from a representation in bytes.