sc_auth(8) BSD System Manager's Manual sc_auth(8)NAME
sc_auth -- SmartCard authorization setup script
SYNOPSIS
sc_auth pair [-v] -u user -h hash
sc_auth unpair [-v] [-u user] [-h hash]
sc_auth pairing_ui [-v] [-f] [-s enable|disable|status]
sc_auth identities
sc_auth list [-v] [-u user] [-d domain]
sc_auth changepin [-t tokenid] [-u]
sc_auth enable_for_login -c class-id
SYNOPSIS - legacy
sc_auth accept [-v] [-u user] [-d domain] [-k keyname]
sc_auth accept [-v] [-u user] [-d domain] -h hash
sc_auth remove [-v] [-u user] [-d domain]
sc_auth hash [-k keyname]
DESCRIPTION
sc_auth configures a local user account to permit authentication using a supported SmartCard. Authentication is via asymmetric key (also
known as public-key) encryption. sc_auth works with signing keys, but not encryption keys.
sc_auth can perform the following actions:
pair Associate a user with a public key. Because user's keychain will be modified to be unlockable by a key, SmartCard with that key must
be present in the reader. The key to use has to be specified by its hash.
unpair Remove association with a user and keychain. If no specific hash is provided, all associations with a user are removed.
pairing_ui
Enable, disable and force to display pairing dialog when card with unpaired identities is inserted
identities
List all identities on all SmartCards and display appropriate associations with users (for associated keys) or key names (for unas-
sociated keys).
list List all public keys associated with a user.
changepin
Change or unblock SmartCard PIN. This command works only for Personal Identity Verification (PIV) SmartCards. With -u argument, PIN
can be unblocked using PUK and without the -u argument, PIN can be changed. Optional -t argument allows specifying tokenID.
enable_for_login
Enable the app extension for login and make the token available to the system for authentication.
DESCRIPTION - legacy
sc_auth can perform the following legacy actions:
accept Associate a user with a public key on a card. The key to use can be specified either by its name or its hash.
remove Remove all public keys associated with a user.
hash Print the hashes for all keys on all inserted cards.
OPTIONS -u user Specifies the user whose account is to be modified
-d domain
Specifies the directory domain containing the user account
-k keyname
Specifies a public key by its name
-h hash Specifies a public key by its hash
-v Verbose mode
-f Force to display pairing dialog
-t tokenid
Specifies a token by tokenID
-c class-id
Specifies a token by 'com.apple.ctk.class-id' from Info.plist
NOTES
sc_auth is a shell script. It is intended to be modified by administrators to suit their local environments.
sc_auth is only known to work with a local directory. Consult the script's source for some limited guidance to using remote directories.
SEE ALSO SmartCardServices(7), SmartCardServices-legacy(7), pam_smartcard(8)MacOSX December 11, 2006 MacOSX
Check Out this Related Man Page
PKCS15-TOOL(1) OpenSC Tools PKCS15-TOOL(1)NAME
pkcs15-tool - utility for manipulating PKCS #15 data structures on smart cards and similar security tokens
SYNOPSIS
pkcs15-tool [OPTIONS]
DESCRIPTION
The pkcs15-tool utility is used to manipulate the PKCS #15 data structures on smart cards and similar security tokens. Users can list and
read PINs, keys and certificates stored on the token. User PIN authentication is performed for those operations that require it.
OPTIONS --aid aid
Specify in a hexadecimal form the AID of the on-card PKCS#15 application to bind to.
--auth-id pin, -a pin
Specifies the auth id of the PIN to use for the operation. This is useful with the --change-pin operation.
--change-pin
Changes a PIN or PUK stored on the token. User authentication is required for this operation.
--dump, -D
Dump card objects.
--learn-card, -L
Cache PKCS #15 token data to the local filesystem. Subsequent operations are performed on the cached data where possible. If the cache
becomes out-of-sync with the token state (eg. new key is generated and stored on the token), the cache should be updated or operations
may show stale results.
--list-applications
List the on-card PKCS#15 applications
--list-certificates, -c
Lists all certificates stored on the token.
--list-data-objects, -C
Lists all data objects stored on the token. For some cards the PKCS#15 attributes of the private data objects are protected for reading
and need the authentication with the User PIN. In such a case the --verify-pin option has to be used.
--list-keys, -k
Lists all private keys stored on the token. General information about each private key is listed (eg. key name, id and algorithm).
Actual private key values are not displayed. For some cards the PKCS#15 attributes of the private keys are protected for reading and
need the authentication with the User PIN. In such a case the --verify-pin option has to be used.
--list-pins
Lists all PINs stored on the token. General information about each PIN is listed (eg. PIN name). Actual PIN values are not shown.
--list-public-keys
Lists all public keys stored on the token, including key name, id, algorithm and length information.
--no-cache
Disables token data caching.
--output filename, -o filename
Specifies where key output should be written. If filename already exists, it will be overwritten. If this option is not given, keys
will be printed to standard output.
--read-certificate cert, -r cert
Reads the certificate with the given id.
--read-data-object cert, -R data
Reads data object with OID, applicationName or label.
--read-public-key id
Reads the public key with id id, allowing the user to extract and store or use the public key.
--read-ssh-key id
Reads the public key with id id, writing the output in format suitable for $HOME/.ssh/authorized_keys.
--reader num
Forces pkcs15-tool to use reader number num for operations. The default is to use reader number 0, the first reader in the system.
--unblock-pin, -u
Unblocks a PIN stored on the token. Knowledge of the Pin Unblock Key (PUK) is required for this operation.
--verbose, -v
Causes pkcs15-tool to be more verbose. Specify this flag several times to enable debug output in the OpenSC library.
--verify-pin
Verify PIN after card binding and before issuing any command (without 'auth-id' the first non-SO, non-Unblock PIN will be verified)
SEE ALSO pkcs15-init(1), pkcs15-crypt(1)opensc 06/17/2014 PKCS15-TOOL(1)