man pages section 5: Standards, Environments, and Macros

Exit Print View

Updated: July 2014



pam_pkcs11 - PAM Authentication Module for the PKCS#11 token libraries

Synopsis [debug] [config_file=filename]


The pam_pkcs11 module implements pam_sm_authenticate(3PAM), which provides functionality to the PAM authentication stack. This module allows a user to login a system, using a X.509 certificate and its dedicated private key stored in a PKCS#11 token. This module currently supports the RSA algorithm only.

To verify the dedicated private key is truly associated with the X.509 certificate, the following verification procedure is performed in this module by default:

  • Generate 128 random byte data

  • Sign the random data with the private key and get a signature. This step is done in the PKCS#11 token.

  • Verify the signature using the public key extracted from the certificate.

For the verification of the users' certificates, locally stored CA certificates as well as either online or locally accessible CRLs are used.


The service module can be used in the <auth> PAM chain. The program that needs a PAM service should be configured in /etc/pam.conf or /etc/pam.d/service. For details on how to configure PAM services, see pam.conf(4).

The following example uses only pam_pkcs11 for authentication:

login auth requisite
login autho required

The following example uses pam_pkcs11 for authentication with fallback to standard UNIX authentication:

login auth sufficient
login auth requisite
login auth required
login auth required
login auth required


To configure the pam_pkcs11 module, you must have the following information:

  • Which PKCS #11 token you are going to use

  • Which mapper(s) you need, and if needed, how to create and edit the related mapping files

  • The root Certificate Authority files, and if required, the Certificate Revocation Lists files

  • The list of authorized users to login, and their corresponding certificates

To configure the pam_pkcs11 module, you need to modify the pam_pkcs11.conf configuration file which is in the /etc/security/pam_pkcs11 directory by default. For detailed information on how to configure the pam_pkcs11 module, see the PAM-PKCS11 User Manual, available at the web site, under the PAM PKCS#11 link.

The following example illustrates how to configure the pam_pkcs11 module for a user whose certificate and private key are stored in the Solaris pkcs11_softtoken keystore. This example uses the default certificate verification policy.

  • Set up the PKCS#11 module.

    On Solaris, the PKCS#11 module should be set to /usr/lib/, the PKCS#11 Cryptographic Framework library.

  • Set up the slot_description entry.

    Specifies the slot to be used. For example, slot_description = "Sun Crypto Softtoken". The default value for this entry is none which means to use the first slot with an available token.

    An administrator can use the cryptoadm list -vcommand to find all the available slots and their slot descriptions. For more information, see libpkcs11(3LIB) and cryptoadm(1M).

  • Install or create user certificates and its dedicated private keys in the specific PKCS#11 token.

  • Set up the certificate verification policy (cert_policy). If needed, set up CA certificate and CRL files.

    The certificate verification policy includes:


    Perform no verification


    Perform CA check


    Perform a signature check to ensure that private and public key matches


    Perform various certificate revocation checking

    As this example uses the default policy, cert_policy = ca,signature, an administer needs to set up the CA certificates.

    • Copy the CA certificate to the /etc/security/pam_pkcs11/cacerts directory.

      A certificate that is self-signed is its own CA certificate. Therefore, in this example, the certificate is placed both in the Softtoken keystore and in the CA certificate directory.

    • Make hash links for CA certificates

      $ /etc/security/pam_pkcs11/ \
  • Set up the mappers and mapfiles.

    When a X509 certificate is provided, there are no direct ways to map a certificate to a login. The pam_pkcs11 module provides a configurable way with mappers to specify cert-to-user mapping.

    Many mappers are provided by the pam_pkcs11 module, for example, the common name (CN) mapper, the digest mapper, the Email mapper, or the LDAP mapper.

    A user can configure a mapper list in the pam_pkcs11.conf file. The mappers in the list are used sequentially until the certificate is successfully matched with the user.

    The default mapper list is as follows:

    use_mappers = digest, cn, pwent, uid, mail, subject, null;

    Some mappers do not require the specification of a mapfile, for example, the common name mapper. Other mappers require mapfiles, for example, the digest mapper. Some sample mapping files can be found in the /etc/security/pam_pkcs11 directory.


The following options are supported:


Specify the configuration file. The default value is /etc/security/pam_pkcs11/pam_pkcs11.conf.


Enable debugging output.



pam_pkcs11 module


Mapper module.


Mapper module.


Mapper module.


Configuration file.


Configuration directory. Stores the CA certificates.


Configuration directory. Stores the CRL files.


Sample mapfile.


Sample mapfile.


Sample mapfile.


Sample script.



PAM-pkcs11 was originally written by MarioStrasser ,

Newer versions are from Juan Antonio Martinez,


See attributes(5) for a description of the following attributes:

library/security/pam/module/pam-pkcs11, SUNWpampkcs11r, SUNWpampkcs11-docs
Interface Stability

See also

pkcs11_inspect(1), pklogin_finder (1), cryptoadm(1M), libpkcs11(3LIB)libpkcs11(3LIB) pam_sm_authenticate(3PAM), pam.conf(4), attributes(5), pkcs11_softtoken(5)

PAM-PKCS11 User Manual, available at the web site, under the PAM PKCS#11 link.