Cryptographic Token Interface Standard

PKCS#11


Function return values


Sections

Universal Cryptoki function return values
Cryptoki function return values for functions that use a session handle
Cryptoki function return values for functions that use a token
Special return value for application-supplied callbacks
Special return values for mutex-handling functions
All other Cryptoki function return values
More on relative priorities of Cryptoki errors
Error code 'gotchas'

Detailed Description

The Cryptoki interface possesses a large number of functions and return values. In Section 11.1, we enumerate the various possible return values for Cryptoki functions; most of the remainder of Section 11 details the behavior of Cryptoki functions, including what values each of them may return.

Because of the complexity of the Cryptoki specification, it is recommended that Cryptoki applications attempt to give some leeway when interpreting Cryptoki functions' return values. We have attempted to specify the behavior of Cryptoki functions as completely as was feasible; nevertheless, there are presumably some gaps. For example, it is possible that a particular error code which might apply to a particular Cryptoki function is unfortunately not actually listed in the description of that function as a possible error code. It is conceivable that the developer of a Cryptoki library might nevertheless permit his/her implementation of that function to return that error code. It would clearly be somewhat ungraceful if a Cryptoki application using that library were to terminate by abruptly dumping core upon receiving that error code for that function. It would be far preferable for the application to examine the function's return value, see that it indicates some sort of error (even if the application doesn't know precisely what kind of error), and behave accordingly.

See Section 11.1.8 for some specific details on how a developer might attempt to make an application that accommodates a range of behaviors from Cryptoki libraries.


RSA Security Inc. Public-Key Cryptography Standards - PKCS#11 - v210