NAME

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

SYNPOSIS

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

DESCRIPTION

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

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

$rv = $obj->get_certificateHandle($certificateHandle)

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

$certificateHandle = $obj->certificateHandle

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

$rv = $obj->set_certificateHandle($certificateHandle)

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

$rv = $obj->get_pSigningMechanism($pSigningMechanism)

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

$pSigningMechanism = $obj->pSigningMechanism

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

$rv = $obj->set_pSigningMechanism($pSigningMechanism)

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

$rv = $obj->get_pDigestMechanism($pDigestMechanism)

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

$pDigestMechanism = $obj->pDigestMechanism

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

$rv = $obj->set_pDigestMechanism($pDigestMechanism)

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

$rv = $obj->get_pContentType($pContentType)

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

$pContentType = $obj->pContentType

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

$rv = $obj->set_pContentType($pContentType)

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

$rv = $obj->get_pRequestedAttributes($pRequestedAttributes)

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

$pRequestedAttributes = $obj->pRequestedAttributes

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

$rv = $obj->set_pRequestedAttributes($pRequestedAttributes)

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

$rv = $obj->get_pRequiredAttributes($pRequiredAttributes)

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

$pRequiredAttributes = $obj->pRequiredAttributes

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

$rv = $obj->set_pRequiredAttributes($pRequiredAttributes)

Set the value pRequiredAttributes 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.