view release on metacpan or  search on metacpan

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

=encoding utf8

=head1 NAME

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

=head1 SYNPOSIS

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

=head1 DESCRIPTION

This is the Perl interface for the C structure CK_CAMELLIA_CBC_ENCRYPT_DATA_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_CAMELLIA_CBC_ENCRYPT_DATA_PARAMS->new

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

=item $rv = $obj->get_iv($iv)

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

=item $iv = $obj->iv

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

=item $rv = $obj->set_iv($iv)

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

=item $rv = $obj->get_pData($pData)

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

=item $pData = $obj->pData

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

=item $rv = $obj->set_pData($pData)

Set the value B<pData> 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.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=back

=head1 NOTE

Derived from the RSA Security Inc. PKCS #11 Cryptographic Token Interface (Cryptoki)

=head1 AUTHOR

Jerry Lundström <lundstrom.jerry@gmail.com>

=head1 REPORTING BUGS

Report bugs at https://github.com/dotse/p5-Crypt-PKCS11/issues .