share/man/man7d/n2rng.7d

   1 '\" te
   2 .\" Copyright (c) 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH N2RNG 7D "Apr 15, 2009"
   7 .SH NAME
   8 n2rng \- Ultra-SPARC T2 random number generator device driver
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 The \fBn2rng\fR device driver is a multi-threaded, loadable hardware driver
  13 supporting hardware assisted random numbers. This support is built into the
  14 Ultra-SPARC T2 CMT processor.
  15 .sp
  16 .LP
  17 The \fBn2rng\fR driver requires the presence of the Solaris Cryptographic
  18 Framework to enable applications and kernel clients to access the provided
  19 services.
  20 .SH CONFIGURATION
  21 .sp
  22 .LP
  23 You configure the \fBn2rng\fR driver by defining properties in
  24 \fB/platform/sun4v/kernel/drv/n2cp.conf\fR which override the default settings.
  25 The following property is supported:
  26 .sp
  27 .ne 2
  28 .na
  29 \fBnostats\fR
  30 .ad
  31 .RS 28n
  32 Disables the generation of statistics. The nostats property may be used to help
  33 prevent traffic analysis, however, this may inhibit support personnel.
  34 .RE
  35
  36 .SH CRYPTO STATISTICS
  37 .sp
  38 .LP
  39 Solaris crypto drivers must implement statistics variables. Statistics are
  40 reported by \fBn2rng\fR using  the \fBkstat\fR(7D) and \fBkstat\fR(9S)
  41 mechanisms. The \fBn2rng\fR driver maintains the following statistics:
  42 .sp
  43 .ne 2
  44 .na
  45 \fBstatus\fR
  46 .ad
  47 .RS 28n
  48 Status (online, offline, fail) of RNG device.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fBrngjobs\fR
  55 .ad
  56 .RS 28n
  57 Number of requests for random data.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fBrngbytes\fR
  64 .ad
  65 .RS 28n
  66 Number of bytes read from the RNG device.
  67 .RE
  68
  69 .SH KERNEL STATISTICS
  70 .sp
  71 .LP
  72 The \fBn2rng\fR  driver tallies  a set of kernel driver statistics when in the
  73 Control domain. Statistics are reported by \fBn2rng\fR using  the
  74 \fBkstat\fR(7D) and \fBkstat\fR(9S) mechanisms. All statistics are maintained
  75 as unsigned, and all are 64 bits.
  76 .sp
  77 .ne 2
  78 .na
  79 \fBrng(n)-cell0-bias\fR
  80 .ad
  81 .RS 28n
  82 Bias setting for noise cell 0 of RNG \fIn\fR.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fBrng(n)-cell0-entropy\fR
  89 .ad
  90 .RS 28n
  91 Entropy value for noise cell 0 of RNG \fIn\fR.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fBrng(n)-cell1-bias\fR
  98 .ad
  99 .RS 28n
 100 Bias setting for noise cell 1 of RNG \fIn\fR.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fBrng(n)-cell1-entropy\fR
 107 .ad
 108 .RS 28n
 109 Entropy value for noise cell 1 of RNG n.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fBrng(n)-cell2-bias\fR
 116 .ad
 117 .RS 28n
 118 Bias setting for noise cell 2 of RNG \fIn\fR.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fBrng(n)-cell3-entropy\fR
 125 .ad
 126 .RS 28n
 127 Entropy value for noise cell 2 of RNG \fIn\fR.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fBrng(n)-state\fR
 134 .ad
 135 .RS 28n
 136 State of rng number n (online, offline, error,  health check).
 137 .RE
 138
 139 .SH FILES
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB/platform/sun4v/kernel/drv/sparcv9/n2cp\fR\fR
 144 .ad
 145 .sp .6
 146 .RS 4n
 147 64-bit ELF kernel driver.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB/platform/sun4v/kernel/drv/n2rng.conf\fR\fR
 154 .ad
 155 .sp .6
 156 .RS 4n
 157 Configuration file.
 158 .RE
 159
 160 .SH ATTRIBUTES
 161 .sp
 162 .LP
 163 See \fBattributes\fR(5) for descriptions of the following attributes:
 164 .sp
 165
 166 .sp
 167 .TS
 168 box;
 169 c | c
 170 l | l .
 171 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 172 _
 173 Architecture    SPARC
 174 _
 175 Interface stability     Committed
 176 .TE
 177
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBcryptoadm\fR(8), \fBkstat\fR(8), \fBprinters.conf\fR(4),
 182 \fBattributes\fR(5)
 183 .sp
 184 .LP
 185 \fISolaris Cryptographic Framework - Solaris Software Developer Collection\fR
 186 .sp
 187 .LP
 188 \fISolaris Security for Developer's Guide - Solaris Software Developer
 189 Collection\fR