usr/src/man/man7d/ncp.7d

   1 '\" te
   2 .\" Copyright 2009, Sun Microsystems, Inc. All Rights Reserved
   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 .\" 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 .\" 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
   6 .\" with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH NCP 7D "Jun 7, 2006"
   8 .SH NAME
   9 ncp \- UltraSPARC T1 server crypto provider device driver
  10 .SH DESCRIPTION
  11 .sp
  12 .LP
  13 The \fBncp\fR device driver is a multi-threaded, loadable hardware driver
  14 supporting hardware assisted acceleration of RSA and DSA cryptographic
  15 operations. This support is built into the UltraSPARC T1 processor.
  16 .sp
  17 .LP
  18 The \fBncp\fR driver requires the presence of the \fISolaris Cryptographic
  19 Framework\fR to enable applications and kernel clients to access the provided
  20 services.
  21 .SH CONFIGURATION
  22 .sp
  23 .LP
  24 You configure the \fBncp\fR driver by defining  properties in
  25 \fB/platform/sun4v/kernel/drv/ncp.conf\fR which override the default settings.
  26 The following property is supported:
  27 .sp
  28 .ne 2
  29 .na
  30 \fBnostats\fR
  31 .ad
  32 .RS 11n
  33 Disables the generation of  statistics. The \fBnostats\fR property may be used
  34 to help prevent traffic  analysis, but this may inhibit support personnel.
  35 .RE
  36
  37 .SH NETWORK STATISTICS
  38 .sp
  39 .LP
  40 Solaris network drivers must implement statistics variables. The \fBncp\fR
  41 driver maintains the following statistics:
  42 .sp
  43 .ne 2
  44 .na
  45 \fBmauXqfull\fR
  46 .ad
  47 .RS 22n
  48 Number of times the queue for MAU X was found full when attempting to submit
  49 jobs.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fBmauXupdate_failure\fR
  56 .ad
  57 .RS 22n
  58 Number of submit job failures on MAU X.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fBmauXsubmit\fR
  65 .ad
  66 .RS 22n
  67 Number of jobs submitted to MAU X since driver load (boot).
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fBrsapublic\fR
  74 .ad
  75 .RS 22n
  76 Total number of  jobs submitted to the device for RSA public key operations.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fBrsaprivate\fR
  83 .ad
  84 .RS 22n
  85 Total number of  jobs submitted to the device for RSA private key operations.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fBdsasign\fR
  92 .ad
  93 .RS 22n
  94 Total number of  jobs submitted to the device for DSA signing.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fBdsaverify\fR
 101 .ad
 102 .RS 22n
 103 Total number of jobs submitted to the device for DSA verification.
 104 .RE
 105
 106 .sp
 107 .LP
 108 Additional statistics may be supplied for Sun support personnel, but are not
 109 useful to Solaris users and are not doc-    umented in this manpage.
 110 .SH ATTRIBUTES
 111 .sp
 112 .LP
 113 See \fBattributes\fR(5) for descriptions of the following attributes:
 114 .sp
 115
 116 .sp
 117 .TS
 118 box;
 119 c | c
 120 l | l .
 121 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 122 _
 123 Architecture    SPARC
 124 _
 125 Interface Stability     Unstable
 126 .TE
 127
 128 .SH FILES
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB/platform/sun4v/kernel/drv/sparcv9/ncp\fR\fR
 133 .ad
 134 .sp .6
 135 .RS 4n
 136 64-bit ELF kernel driver.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB/platform/sun4v/kernel/drv/ncp.conf\fR\fR
 143 .ad
 144 .sp .6
 145 .RS 4n
 146 Configuration file.
 147 .RE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBcryptoadm\fR(1M), \fBkstat\fR(1M), \fBprtconf\fR(1M), \fBattributes\fR(5)
 153 .sp
 154 .LP
 155 \fISolaris Cryptographic Framework\fR \(em Solaris Software Developer
 156 Collection
 157 .sp
 158 .LP
 159 \fISolaris Security for Developer's Guide\fR \(em Solaris Software Developer
 160 Collection