This document is intended for developers and architects who wish to design systems and applications that conform to the PKCS#11 Cryptographic Token Interface specification.

The PKCS #11 Cryptographic Token Interface specification standard documents an API for devices that may hold cryptographic information and may perform cryptographic functions.

Status:

This document was last revised or approved by the OASIS PKCS 11 TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/pkcs11/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/pkcs11/ipr.php).

Citation format:

When referencing this specification the following citation format should be used:

[PKCS11-profiles]

PKCS #11 Cryptographic Token Interface Profiles Version 2.40. 30 October 2013. OASIS Committee Specification Draft 01 / Public Review Draft 01. http://docs.oasis-open.org/pkcs11/pkcs11-profiles/v2.40/csprd01/pkcs11-profiles-v2.40-csprd01.html.

Notices

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/policies-guidelines/trademark for above guidance.

Table of Contents

1 Introduction. 5

1.1 Terminology. 5

1.2 Normative References. 5

1.3 Non-Normative References. 5

2 Profiles. 6

2.1 Guidelines for Specifying Conformance Clauses. 6

2.2 Guidelines for Validating Conformance to PKCS11 Profiles. 6

3 Conformance. 7

3.1 Baseline Consumer Clause. 7

3.1.1 Implementation Conformance. 7

3.1.2 Conformance of a PKCS11 Baseline Consumer 7

3.2 Baseline Provider Clause. 8

3.2.1 Implementation Conformance. 8

3.2.2 Conformance of a PKCS11 Baseline Provider 8

3.3 Extended Consumer Clause. 9

3.3.1 Implementation Conformance. 9

3.3.2 Conformance of a PKCS11 Extended Provider 9

3.4 Extended Provider Clause. 9

3.4.1 Implementation Conformance. 9

3.4.2 Conformance of a PKCS11 Extended Provider 10

3.5 Authentication Token Clause. 10

3.5.1 Implementation Conformance. 10

3.5.2 Conformance of a Authentication Token. 10

Appendix A. Acknowledgments. 12

Appendix B. Revision History. 14

1 Introduction

OASIS requires a conformance section in an approved committee specification ([PKCS11-SPEC] [TCPROC], section 2.18 Work Product Quality, paragraph 8a):

A specification that is approved by the TC at the Public Review Draft, Committee Specification or OASIS Standard level must include a separate section, listing a set of numbered conformance clauses, to which any implementation of the specification must adhere in order to claim conformance to the specification (or any optional portion thereof).

This document intends to meet this OASIS requirement on conformance clauses for providers and consumers of cryptographic services via PKCS11 ([PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance) through profiles that define the use of PKCS11 data types, objects, functions and mechanisms within specific contexts of provider and consumer interaction. These profiles define a set of normative constraints for employing PKCS11 within a particular environment or context of use. They may, optionally, require the use of specific PKCS11 functionality or in other respects define the processing rules to be followed by profile actors.

For normative definition of the elements of PKCS11 specified in these profiles, see the PKCS #11 Cryptographic Token Interface Base Specification ([PKCS11-SPEC]).and the PKCS #11 Cryptographic Token Interface Current Mechanisms ([PKCS11-CMECH]). Illustrative guidance for the implementation of providers and consumers of PKCS11 is provided in the PKCS #11 Cryptographic Token Interface Usage Guide ([PKCS11-UG]).

1.1 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].

1.2 Normative References

[PKCS11-CMECH] PKCS #11 Cryptographic Token Interface Current Mechanisms Specification Version <<VERSION>>. <<DATE>>. OASIS Working Draft, <<URI>>

[PKCS11-HMECH] PKCS #11 Cryptographic Token Interface Historical Mechanisms Specification Version <<VERSION>>. <<DATE>>, OASIS Working Draft, <<URI>>

[PKCS11-SPEC] PKCS #11 Cryptographic Token Interface Base Specification Version <<VERSION>>. <<DATE>>. OASIS Working Draft, <<URI>>

[RFC2119] Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, March 1997. http://www.ietf.org/rfc/rfc2119.txt.

[TCPROC] OASIS, Technical Committee (TC) Process, Version 31 January 2013, 31January 2013, https://www.oasis-open.org/policies-guidelines/tc-process.

1.3 Non-Normative References

[PKCS11-UG] PKCS #11 Cryptographic Token Interface Usage Guide Specification Version <<VERSION>>. <<DATE>>. OASIS Working Draft, <<URI>>

2 Profiles

This document defines a selected set of conformance clauses which form PKCS11 Profiles. The PKCS11 TC also welcomes proposals for new profiles. PKCS11 TC members are encouraged to submit these proposals to the PKCS11 TC for consideration for inclusion in a future version of this TC-approved document. However, some OASIS members may simply wish to inform the committee of profiles or other work related to PKCS11.

2.1 Guidelines for Specifying Conformance Clauses

This section provides a checklist of issues that SHALL be addressed by each clause.

1. Implement functionality as mandated by [PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance)

2. Specify the list of additional data types that SHALL be supported

3. Specify the list of additional objects that SHALL be supported

4. Specify the list of additional functions that SHALL be supported

5. Specify the list of additional mechanisms that SHALL be supported

2.2 Guidelines for Validating Conformance to PKCS11 Profiles

A PKCS11 provider implementation SHALL claim conformance to a specific provider profile only if it instruments all required data types, objects, functions and mechanisms of that profile

• All data types specified as required in that profile

• All objects specified as required in that profile

• All functions specified as required in that profile

• All mechanisms specified as required in that profile

A PKCS11 consumer implementation SHALL claim conformance to a specific consumer profile only if it instruments all required data types, objects, functions and mechanisms of that profile

• All data types specified as required in that profile

• All objects specified as required in that profile

• All functions specified as required in that profile

• All mechanisms specified as required in that profile

3 Conformance

The following subsections describe currently-defined profiles related to the use of PKCS11.

3.1 Baseline Consumer Clause

This profile builds on the Baseline ProviPKCS11 consumer conformance clauses to provide some of the most basic functionality that would be expected of a conformant PKCS11 consumer – the ability to consume information via the cryptographic services offered by a provider.

3.1.1 Implementation Conformance

An implementation is a conforming Baseline Consumer Clause if it meets the conditions as outlined in the following section.

3.1.2 Conformance of a PKCS11 Baseline Consumer

An implementation conforms to this specification as a Baseline Consumer if it meets the following conditions:

Supports the conditions required by the PKCS11 conformance clauses ([PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance)
Supports the following data types:

CK_VERSION ([PKCS11-SPEC] 3.1)
CK_INFO ([PKCS11-SPEC] 3.1)
CK_SLOT_ID ([PKCS11-SPEC] 3.2)
CK_SLOT_INFO ([PKCS11-SPEC] 3.2)
CK_TOKEN_INFO ([PKCS11-SPEC] 3.2)
CK_SESSION_HANDLE ([PKCS11-SPEC] 3.3)
CK_USER_TYPE ([PKCS11-SPEC] 3.3)
CK_SESSION_INFO ([PKCS11-SPEC] 3.3)
CK_OBJECT_HANDLE ([PKCS11-SPEC] 3.4)
CK_OBJECT_CLASS ([PKCS11-SPEC] 3.4)
CK_ATTRIBUTE_TYPE ([PKCS11-SPEC] 3.4)
CK_ATTRIBUTE ([PKCS11-SPEC] 3.4)
CK_RV ([PKCS11-SPEC] 3.6)
CK_FUNCTION_LIST ([PKCS11-SPEC] 3.6)
CK_C_INITIALIZE_ARGS ([PKCS11-SPEC] 3.7)

Supports the following objects:

CKA_CLASS ([PKCS11-SPEC] 4.2)
CKA_VALUE ([PKCS11-SPEC])

Supports the following functions:

C_GetFunctionList ([PKCS11-SPEC] 5.4)
C_Initialize ([PKCS11-SPEC] 5.4)
C_Finalize ([PKCS11-SPEC] 5.4)
C_GetInfo ([PKCS11-SPEC] 5.4)
C_GetSlotList ([PKCS11-SPEC] 5.5)
C_GetSlotInfo ([PKCS11-SPEC] 5.5)
C_GetTokenInfo ([PKCS11-SPEC] 5.5)
C_OpenSession ([PKCS11-SPEC] 5.6)
C_CloseSession ([PKCS11-SPEC] 5.6)

Supports the following mechanisms:

None specified

Supports Error Handling ([PKCS11-SPEC] 5.1) for any supported object, function or mechanism
Optionally supports any clause within [PKCS11-SPEC] that is not listed above
Optionally supports extensions outside the scope of this standard (e.g., vendor defined extensions, conformance clauses) that do not contradict any PKCS11 requirements

3.2 Baseline Provider Clause

This profile builds on the PKCS11 provider conformance clauses to provide some of the most basic functionality that would be expected of a conformant PKCS11 provider – the ability to provide information about the capabilities of the cryptographic services provided.

3.2.1 Implementation Conformance

An implementation is a conforming Baseline Provider Clause if it meets the conditions as outlined in the following section.

3.2.2 Conformance of a PKCS11 Baseline Provider

An implementation conforms to this specification as a Baseline Provider if it meets the following conditions:

Supports the conditions required by the PKCS11 conformance clauses ([PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance)
Supports the following data types:

CK_VERSION ([PKCS11-SPEC] 3.1)
CK_INFO ([PKCS11-SPEC] 3.1)
CK_SLOT_ID ([PKCS11-SPEC] 3.2)
CK_SLOT_INFO ([PKCS11-SPEC] 3.2)
CK_TOKEN_INFO ([PKCS11-SPEC] 3.2)
CK_SESSION_HANDLE ([PKCS11-SPEC] 3.3)
CK_USER_TYPE ([PKCS11-SPEC] 3.3)
CK_SESSION_INFO ([PKCS11-SPEC] 3.3)
CK_OBJECT_HANDLE ([PKCS11-SPEC] 3.4)
CK_OBJECT_CLASS ([PKCS11-SPEC] 3.4)
CK_ATTRIBUTE_TYPE ([PKCS11-SPEC] 3.4)
CK_ATTRIBUTE ([PKCS11-SPEC] 3.4)
CK_RV ([PKCS11-SPEC] 3.6)
CK_FUNCTION_LIST ([PKCS11-SPEC] 3.6)
CK_C_INITIALIZE_ARGS ([PKCS11-SPEC] 3.7)

Supports the following objects:

CKA_CLASS ([PKCS11-SPEC] 4.2)
CKA_TOKEN ([PKCS11-SPEC] 4.2)
CKA_VALUE ([PKCS11-SPEC])
CKA_ID ([PKCS11-SPEC])
CKA_PRIVATE ([PKCS11-SPEC] x.y)
CKA_MODIFIABLE ([PKCS11-SPEC)
CKA_LABEL ([PKCS11-SPEC)

Supports the following functions:

C_GetFunctionList ([PKCS11-SPEC] 5.4)
C_Initialize ([PKCS11-SPEC] 5.4)
C_Finalize ([PKCS11-SPEC] 5.4)
C_GetInfo ([PKCS11-SPEC] 5.4)
C_GetSlotList ([PKCS11-SPEC] 5.5)
C_GetSlotInfo ([PKCS11-SPEC] 5.5)
C_GetTokenInfo ([PKCS11-SPEC] 5.5)
C_OpenSession ([PKCS11-SPEC] 5.6)
C_CloseSession ([PKCS11-SPEC] 5.6)
C_GetSessionInfo ([PKCS11-SPEC] 5.6)
C_FindObjectsInit ([PKCS11-SPEC] 5.6)
C_FindObjects ([PKCS11-SPEC] 5.6)
C_FindObjectsFinal ([PKCS11-SPEC] 5.6)
C_GetAttributeValue ([PKCS11-SPEC] 5.7)

Supports the following mechanisms:

None specified

Supports Error Handling ([PKCS11-SPEC] 5.1) for any supported object, function or mechanism
Optionally supports any clause within [PKCS11-SPEC] that is not listed above
Optionally supports extensions outside the scope of this standard (e.g., vendor defined extensions, conformance clauses) that do not contradict any PKCS11 requirements

3.3 Extended Consumer Clause

This profile builds on the baseline consumer clause to add support for mechanism based usage.

3.3.1 Implementation Conformance

An implementation is a conforming Extended Consumer Clause if it meets the conditions as outlined in the following section.

3.3.2 Conformance of a PKCS11 Extended Provider

An implementation conforms to this specification as Extended Provider if it meets the following conditions:

Supports the conditions required by the PKCS11 conformance clauses ([PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance)
Supports the conditions required by the PKCS11 Baseline Consumer clauses section 3.1
Supports the following additional data types:

CK_MECHANISM_TYPE ([PKCS11-SPEC] 3.4)
CK_MECHANISM ([PKCS11-SPEC] 3.4)

Supports the following additional objects:

None specified

Supports the following additional functions:

C_GetMechanismList ([PKCS11-SPEC] 5.5)
C_GetMechanismInfo ([PKCS11-SPEC] 5.5)

Supports the following additional mechanisms:

None specified

Supports Error Handling ([PKCS11-SPEC] 5.1) for any supported object, function or mechanism
Optionally supports any clause within [PKCS11-SPEC] that is not listed above
Optionally supports extensions outside the scope of this standard (e.g., vendor defined extensions, conformance clauses) that do not contradict any PKCS11 requirements

3.4 Extended Provider Clause

This profile builds on the baseline provider clause to add support for mechanism based usage.

3.4.1 Implementation Conformance

An implementation is a conforming Extended Provider Clause if it meets the conditions as outlined in the following section.

3.4.2 Conformance of a PKCS11 Extended Provider

An implementation conforms to this specification as Extended Provider if it meets the following conditions:

Supports the conditions required by the PKCS11 conformance clauses ([PKCS11-SPEC] Section 6 (PKCS#11 Implementation Conformance)
Supports the conditions required by the PKCS11 Baseline Provider clauses section 3.2.
Supports the following additional data types:

CK_MECHANISM_TYPE ([PKCS11-SPEC] 3.4)
CK_MECHANISM ([PKCS11-SPEC] 3.4)

Supports the following additional objects:

None specified

Supports the following additional functions:

C_GetMechanismList ([PKCS11-SPEC] 5.5)
C_GetMechanismInfo ([PKCS11-SPEC] 5.5)
C_Login ([PKCS11-SPEC] 5.6)
C_Logout ([PKCS11-SPEC] 5.6)

Supports the following additional mechanisms:

None specified

Supports Error Handling ([PKCS11-SPEC] 5.1) for any supported object, function or mechanism
Optionally supports any clause within [PKCS11-SPEC] that is not listed above
Optionally supports extensions outside the scope of this standard (e.g., vendor defined extensions, conformance clauses) that do not contradict any PKCS11 requirements

If the implementation is a consumer then it SHALL support the conditions required by the PKCS11 Baseline Consumer Clause (Section 3.1)
If the implementation is a provider then it SHALL support the conditions required by the PKCS11 Baseline Provider Clause (Section 3.2)
Supports the following objects:

CKO_PRIVATE_KEY
CKO_PUBLIC_KEY

Supports the following functions:

C_Login
C_Logout
C_SignInit
C_Sign and/or C_SignUpdate and C_SignFinal

Supports the following mechanisms:

None specified

Optionally supports any clause within [PKCS11-SPEC] that is not listed above
Optionally supports extensions outside the scope of this standard (e.g., vendor defined extensions, conformance clauses) that do not contradict any PKCS11 requirements.

Appendix A. Acknowledgments

The following individuals have participated in the creation of this specification and are gratefully acknowledged:

Participants:

Gil Abel, Athena Smartcard Solutions, Inc.

Warren Armstrong, QuintessenceLabs

Peter Bartok, Venafi, Inc.

Anthony Berglas, Cryptsoft

Kelley Burgin, National Security Agency

Robert Burns, Thales e-Security

Wan-Teh Chang, Google Inc.

Hai-May Chao, Oracle

Janice Cheng, Vormetric, Inc.

Sangrae Cho, Electronics and Telecommunications Research Institute (ETRI)

Doron Cohen, SafeNet, Inc.

Fadi Cotran, Futurex

Tony Cox, Cryptsoft

Christopher Duane, EMC

Chris Dunn, SafeNet, Inc.

Valerie Fenwick, Oracle

Terry Fletcher, SafeNet, Inc.

Susan Gleeson, Oracle

Sven Gossel, Charismathics

Robert Griffin, EMC

Paul Grojean, Individual

Peter Gutmann, Individual

Dennis E. Hamilton, Individual

Thomas Hardjono, M.I.T.

Tim Hudson, Cryptsoft

Gershon Janssen, Individual

Seunghun Jin, Electronics and Telecommunications Research Institute (ETRI)

Andrey Jivsov, Symantec Corp.

Greg Kazmierczak, Wave Systems Corp.

Mark Knight, Thales e-Security

Darren Krahn, Google Inc.

Alex Krasnov, Infineon Technologies AG

Dina Kurktchi-Nimeh, Oracle

Mark Lambiase, SecureAuth Corporation

Lawrence Lee, GoTrust Technology Inc.

John Leiseboer, QuintessenceLabs

Hal Lockhart, Oracle

Robert Lockhart, Thales e-Security

Dale Moberg, Axway Software

Darren Moffat, Oracle

Valery Osheter, SafeNet, Inc.

Sean Parkinson, EMC

Rob Philpott, EMC

Mark Powers, Oracle

Ajai Puri, SafeNet, Inc.

Robert Relyea, Red Hat

Saikat Saha, Oracle

Subhash Sankuratripati, NetApp

Johann Schoetz, Infineon Technologies AG

Rayees Shamsuddin, Wave Systems Corp.

Radhika Siravara, Oracle

Brian Smith, Mozilla Corporation

David Smith, Venafi, Inc.

Ryan Smith, Futurex

Jerry Smith, US Department of Defense (DoD)

Oscar So, Oracle

Michael Stevens, QuintessenceLabs

Michael StJohns, Individual

Sander Temme, Thales e-Security

Kiran Thota, VMware, Inc.

Walter-John Turnes, Gemini Security Solutions, Inc.

Stef Walter, Red Hat

Jeff Webb, Dell

Magda Zdunkiewicz, Cryptsoft

Chris Zimman, Bloomberg Finance L.P.

Appendix B. Revision History

Revision	Date	Editor	Changes Made
wd01	20-Mar-2013	Tim Hudson	Template provided by OASIS
wd02	3-Apr-2013	Tim Hudson	Initial draft
wd03	18-Sep-2013	Tim Hudson	Updated draft matching current drafts of the specification
wd04	27-Oct-2013	Robert Griffin	Final participant list and other editorial changes for Committee Specification Draft
wd04a	27-Oct-2013	Tim Hudson	Deleted no longer valid comment and corrected unknown section reference.