Blob Blame History Raw
.TH PKCSEP11_SESSION 1 "Jan 2018" "@PACKAGE_VERSION@" "openCryptoki"
.SH NAME
pkcsep11_session \- manage EP11 sessions.

.SH SYNOPSIS
\fBpkcep11_session\fP
[\fB-h\fP]
[\fBshow|logout|vhsmpin\fP \fB-slot\fP \fIslot-number\fP [\fB-id\fP \fIsession-ID\fP]
[\fB-pid\fP \fIprocess-ID\fP] [\fB-date\fP \fIyyyy/mm/dd\fP] [\fB-force\fP] ]

.SH DESCRIPTION
Use pkcep11_session to list and logout leftover EP11 sessions.

EP11 sessions are created and destroyed as a PKCS#11 session is logged
on and off, respectively. When an application terminates abnormally, without
logging out or closing the PKCS#11 session, the corresponding EP11 session
is not destroyed. 

When STRICT_MODE or VHSM_MODE is enabled in the EP11 configuration file, all 
session-keys belong strictly to the PKCS#11 session or token that created it.
These PKCS#11 session keys expire when the session ends.
.br
.SH "COMMAND SUMMARY"
.IP "\fBshow\fP" 10
displays all leftover EP11 sessions. Use the -session-ID, -pid or -date
options to filter the list of sessions.
.IP "\fBlogout\fP" 10
logs out all leftover EP11 sessions. Use the -session-ID, -pid or -date
options to filter the list of sessions.
.IP "\fBvhsmpin\fP" 10
sets the VHSM PIN used for the VHSM_MODE (virtual HSM). The VHSM PIN must
contain between 8 and 16 alphanumeric characters.
.br
\fBNote:\fP When changing the VHSM PIN, all existing keys stored as
token objects become unusable!

.SH "OPTIONS"
.IP "\fB-slot\fP \fIslot-number\fP" 10
specifies the slot of the EP11 token
.IP "\fB-force\fP" 10
deletes a session even if logout fails on some adapters.
.IP "\fB-id\fP \fIsession-ID\fP" 10
specifies the EP11 session ID.
.IP "\fB-pid\fP \fIprocess-ID\fP" 10
specifies the process-ID (pid) for which to display or logout EP11 sessions.
.IP "\fB-date\fP \fIyyyy/mm/dd\fP" 10
filters the EP11 sessions by the specified date.
Any EP11 session with a matching or earlier date are
displayed or logged out. 
.IP "\fB-h\fP" 10
show usage information

.SH SEE ALSO
.PD 0
.TP
\fBpkcsconf\fP(1),
.TP
\fBopencryptoki\fP(7),
.TP
\fBpkcsslotd\fP(8).
.PD