NAME

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

SYNPOSIS

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

DESCRIPTION

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

METHODS

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

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

$rv = $obj->get_mechanism($mechanism)

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

$mechanism = $obj->mechanism

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

$rv = $obj->set_mechanism($mechanism)

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

$rv = $obj->get_pParameter($pParameter)

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

$pParameter = $obj->pParameter

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

$rv = $obj->set_pParameter($pParameter)

Set the value pParameter in the structure. Returns CKR_OK on success otherwise a CKR describing the 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.