/ 
Crypt-PKCS11-1.03
River stage one • 1 direct dependent • 1 total dependent
/ Crypt::PKCS11::CK_WTLS_KEY_MAT_PARAMS

NAME

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

SYNPOSIS

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

DESCRIPTION

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

METHODS

$obj = Crypt::PKCS11::CK_WTLS_KEY_MAT_PARAMS->new

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

$rv = $obj->get_DigestMechanism($DigestMechanism)

Retrieve the value DigestMechanism from the structure into $DigestMechanism. Returns CKR_OK on success otherwise a CKR describing the error.

$DigestMechanism = $obj->DigestMechanism

Returns the value DigestMechanism from the structure or undef on error.

$rv = $obj->set_DigestMechanism($DigestMechanism)

Set the value DigestMechanism in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_ulMacSizeInBits($ulMacSizeInBits)

Retrieve the value ulMacSizeInBits from the structure into $ulMacSizeInBits. Returns CKR_OK on success otherwise a CKR describing the error.

$ulMacSizeInBits = $obj->ulMacSizeInBits

Returns the value ulMacSizeInBits from the structure or undef on error.

$rv = $obj->set_ulMacSizeInBits($ulMacSizeInBits)

Set the value ulMacSizeInBits in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_ulKeySizeInBits($ulKeySizeInBits)

Retrieve the value ulKeySizeInBits from the structure into $ulKeySizeInBits. Returns CKR_OK on success otherwise a CKR describing the error.

$ulKeySizeInBits = $obj->ulKeySizeInBits

Returns the value ulKeySizeInBits from the structure or undef on error.

$rv = $obj->set_ulKeySizeInBits($ulKeySizeInBits)

Set the value ulKeySizeInBits in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_ulIVSizeInBits($ulIVSizeInBits)

Retrieve the value ulIVSizeInBits from the structure into $ulIVSizeInBits. Returns CKR_OK on success otherwise a CKR describing the error.

$ulIVSizeInBits = $obj->ulIVSizeInBits

Returns the value ulIVSizeInBits from the structure or undef on error.

$rv = $obj->set_ulIVSizeInBits($ulIVSizeInBits)

Set the value ulIVSizeInBits in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_ulSequenceNumber($ulSequenceNumber)

Retrieve the value ulSequenceNumber from the structure into $ulSequenceNumber. Returns CKR_OK on success otherwise a CKR describing the error.

$ulSequenceNumber = $obj->ulSequenceNumber

Returns the value ulSequenceNumber from the structure or undef on error.

$rv = $obj->set_ulSequenceNumber($ulSequenceNumber)

Set the value ulSequenceNumber in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_bIsExport($bIsExport)

Retrieve the value bIsExport from the structure into $bIsExport. Returns CKR_OK on success otherwise a CKR describing the error.

$bIsExport = $obj->bIsExport

Returns the value bIsExport from the structure or undef on error.

$rv = $obj->set_bIsExport($bIsExport)

Set the value bIsExport in the structure. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_RandomInfo($RandomInfo)

Retrieve the value RandomInfo from the structure into $RandomInfo which must be a Crypt::PKCS11::CK_WTLS_RANDOM_DATA object. Returns CKR_OK on success otherwise a CKR describing the error.

$RandomInfo = $obj->RandomInfo

Returns the value RandomInfo, as a Crypt::PKCS11::CK_WTLS_RANDOM_DATA object, from the structure or undef on error.

$rv = $obj->set_RandomInfo($RandomInfo)

Set the value RandomInfo in the structure, $RandomInfo must be a Crypt::PKCS11::CK_WTLS_RANDOM_DATA object. Returns CKR_OK on success otherwise a CKR describing the error.

$rv = $obj->get_pReturnedKeyMaterial($pReturnedKeyMaterial)

Retrieve the value pReturnedKeyMaterial from the structure into $pReturnedKeyMaterial which must be a Crypt::PKCS11::CK_WTLS_KEY_MAT_OUT object. Returns CKR_OK on success otherwise a CKR describing the error.

$pReturnedKeyMaterial = $obj->pReturnedKeyMaterial

Returns the value pReturnedKeyMaterial, as a Crypt::PKCS11::CK_WTLS_KEY_MAT_OUT object, from the structure or undef on error.

PRIVATE METHODS

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

$bytes = $obj->toBytes

Return the structure represented as bytes or undef on error.

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

Sets the structure from a representation in bytes. Returns CKR_OK on success otherwise a CKR describing the error.

NOTE

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

AUTHOR

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

REPORTING BUGS

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

LICENSE

Copyright (c) 2015 Jerry Lundström <lundstrom.jerry@gmail.com>
Copyright (c) 2015 .SE (The Internet Infrastructure Foundation)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.