Print this page 
11628 typos detected by mandoc style
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3ext/SUNW_C_GetMechSession.3ext
          +++ new/usr/src/man/man3ext/SUNW_C_GetMechSession.3ext
   1    1  '\" te
   2    2  .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3    3  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4    4  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5    5  .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6      -.TH SUNW_C_GETMECHSESSION 3EXT "April 9, 2016"
        6 +.TH SUNW_C_GETMECHSESSION 3EXT "Aug 27, 2019"
   7    7  .SH NAME
   8    8  SUNW_C_GetMechSession, SUNW_C_KeyToObject \- PKCS#11 Cryptographic Framework
   9    9  functions
  10   10  .SH SYNOPSIS
  11      -.LP
  12   11  .nf
  13   12  cc [ \fIflag \&.\|.\|.\fR ] \fIfile\fR\&.\|.\|. \fB-lpkcs11\fR [ \fIlibrary\&.\|.\|.\fR ]
  14   13  #include <security/cryptoki.h>
  15   14  #include <security/pkcs11.h>
  16   15  
  17   16  \fBCK_RV\fR \fBSUNW_C_GetMechSession\fR(\fBCK_MECHANISM_TYPE\fR \fImech\fR,
  18   17       \fBCK_SESSION_HANDLE_PTR\fR \fIhSession\fR);
  19   18  .fi
  20   19  
  21   20  .LP
  22   21  .nf
  23   22  \fBCK_RV\fR \fBSUNW_C_KeyToObject\fR(\fBCK_SESSION_HANDLE\fR \fIhSession\fR,
  24   23       \fBCK_MECHANISM_TYPE\fR \fImech\fR, \fBconst void *\fR\fIrawkey\fR, \fBsize_t\fR \fIrawkey_len\fR,
  25   24       \fBCK_OBJECT_HANDLE_PTR\fR \fIobj\fR);
  26   25  .fi
  27   26  
  28   27  .SH DESCRIPTION
  29      -.LP
  30   28  These functions implement the RSA PKCS#11 v2.20 specification by using plug-ins
  31   29  to provide the slots.
  32   30  .sp
  33   31  .LP
  34   32  The \fBSUNW_C_GetMechSession()\fR function initializes the PKCS#11
  35   33  cryptographic framework and performs all necessary calls to Standard PKCS#11
  36   34  functions (see \fBlibpkcs11\fR(3LIB)) to create a session capable of providing
  37   35  operations on the requested mechanism. It is not necessary to call
  38      -\fBC_Initalize()\fR or \fBC_GetSlotList()\fR before the first call to
       36 +\fBC_Initialize()\fR or \fBC_GetSlotList()\fR before the first call to
  39   37  \fBSUNW_C_GetMechSession()\fR.
  40   38  .sp
  41   39  .LP
  42   40  If the \fBSUNW_C_GetMechSession()\fR function is called multiple times, it will
  43      -return a new session each time without re-initalizing the framework. If it is
       41 +return a new session each time without re-initializing the framework. If it is
  44   42  unable to return a new session, \fBCKR_SESSION_COUNT\fR is returned.
  45   43  .sp
  46   44  .LP
  47   45  The \fBC_CloseSession()\fR function should be called to release the session
  48   46  when it is no longer required.
  49   47  .sp
  50   48  .LP
  51   49  The \fBSUNW_C_KeyToObject()\fR function creates a key object for the specified
  52   50  mechanism from the \fIrawkey\fR data. The object should be destroyed with
  53   51  \fBC_DestroyObject()\fR when it is no longer required.
  54   52  .SH RETURN VALUES
  55      -.LP
  56   53  The \fBSUNW_C_GetMechSession()\fR function returns the following values:
  57   54  .sp
  58   55  .ne 2
  59   56  .na
  60   57  \fB\fBCKR_OK\fR\fR
  61   58  .ad
  62   59  .RS 25n
  63   60  The function completed successfully.
  64   61  .RE
  65   62
↓ open down ↓ 90 lines elided ↑ open up ↑ 
 156  153  .ad
 157  154  .RS 25n
 158  155  A general error occurred.
 159  156  .RE
 160  157  
 161  158  .sp
 162  159  .LP
 163  160  The return values of each of the implemented functions are defined and listed
 164  161  in the RSA PKCS#11 v2.20 specification. See http://www.rsasecurity.com.
 165  162  .SH USAGE
 166      -.LP
 167  163  These functions are not part of the RSA PKCS#11 v2.20 specification. They are
 168  164  not likely to exist on non-Solaris systems. They are provided as a convenience
 169  165  to application programmers. Use of these functions will make the application
 170  166  non-portable to other systems.
 171  167  .SH ATTRIBUTES
 172      -.LP
 173  168  See \fBattributes\fR(5) for descriptions of the following attributes:
 174  169  .sp
 175  170  
 176  171  .sp
 177  172  .TS
 178  173  box;
 179  174  c | c
 180  175  l | l .
 181  176  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 182  177  _
 183  178  Interface Stability     Evolving
 184  179  _
 185  180  MT-Level        MT-Safe
 186  181  .TE
 187  182  
 188  183  .SH SEE ALSO
 189      -.LP
 190  184  \fBlibpkcs11\fR(3LIB), \fBattributes\fR(5)
 191  185  .sp
 192  186  .LP
 193  187  http://www.rsasecurity.com
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX