diff options
Diffstat (limited to 'static/freebsd/man4/safe.4 3.html')
| -rw-r--r-- | static/freebsd/man4/safe.4 3.html | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/static/freebsd/man4/safe.4 3.html b/static/freebsd/man4/safe.4 3.html new file mode 100644 index 00000000..914126c8 --- /dev/null +++ b/static/freebsd/man4/safe.4 3.html @@ -0,0 +1,118 @@ +<table class="head"> + <tr> + <td class="head-ltitle">SAFE(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">SAFE(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">safe</code> — <span class="Nd">SafeNet + SafeXcel 1141/1741 crypto accelerator</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following lines + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device crypto</code> +<br/> +<code class="Cd">device cryptodev</code> +<br/> +<code class="Cd">device safe</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following line in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>safe_load="YES"</pre> +</div> +<p class="Pp">In <a class="Xr">sysctl.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">hw.safe.debug</code> +<br/> +<code class="Cd">hw.safe.dump</code> +<br/> +<code class="Cd">hw.safe.rnginterval</code> +<br/> +<code class="Cd">hw.safe.rngbufsize</code> +<br/> +<code class="Cd">hw.safe.rngmaxalarm</code></div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DEPRECATION_NOTICE"><a class="permalink" href="#DEPRECATION_NOTICE">DEPRECATION + NOTICE</a></h1> +<p class="Pp">The <code class="Nm">safe</code> driver is deprecated and is + scheduled for removal in <span class="Ux">FreeBSD 16.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">safe</code> driver supports cards containing + SafeNet crypto accelerator chips.</p> +<p class="Pp">The <code class="Nm">safe</code> driver registers itself to + accelerate AES, SHA1-HMAC, and NULL operations for + <a class="Xr">ipsec(4)</a> and <a class="Xr">crypto(4)</a>.</p> +<p class="Pp">On all models, the driver registers itself to provide random data + to the <a class="Xr">random(4)</a> subsystem. Periodically the driver will + poll the hardware RNG and retrieve data for use by the system. If the driver + detects that the hardware RNG is resonating with any local signal, it will + reset the oscillators that generate random data. Three + <a class="Xr">sysctl(8)</a> settings control this procedure: + <var class="Va">hw.safe.rnginterval</var> specifies the time, in seconds, + between polling operations, <var class="Va">hw.safe.rngbufsize</var> + specifies the number of 32-bit words to retrieve on each poll, and + <var class="Va">hw.safe.rngmaxalarm</var> specifies the threshold for + resetting the oscillators.</p> +<p class="Pp">When the driver is compiled with + <code class="Dv">SAFE_DEBUG</code> defined, two <a class="Xr">sysctl(8)</a> + variables are provided for debugging purposes: + <var class="Va">hw.safe.debug</var> can be set to a non-zero value to enable + debugging messages to be sent to the console for each cryptographic + operation, <var class="Va">hw.safe.dump</var> is a write-only variable that + can be used to force driver state to be sent to the console. Set this + variable to “<code class="Li">ring</code>” to dump the current + state of the descriptor ring, to “<code class="Li">dma</code>” + to dump the hardware DMA registers, or to + “<code class="Li">int</code>” to dump the hardware interrupt + registers.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">safe</code> driver supports the following + SafeXcel chips:</p> +<table class="Bl-column Bd-indent"> + <tr> + <td>SafeNet 1141</td> + <td>The original chipset. Supports DES, Triple-DES, AES, MD5, and SHA-1 + symmetric crypto operations, RNG, public key operations, and full IPsec + packet processing.</td> + </tr> + <tr> + <td>SafeNet 1741</td> + <td>A faster version of the 1141.</td> + </tr> +</table> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">crypt(3)</a>, <a class="Xr">crypto(4)</a>, + <a class="Xr">intro(4)</a>, <a class="Xr">ipsec(4)</a>, + <a class="Xr">random(4)</a>, <a class="Xr">crypto(7)</a>, + <a class="Xr">crypto(9)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">safe</code> driver first appeared in + <span class="Ux">FreeBSD 5.2</span>. It is deprecated in + <span class="Ux">FreeBSD 15.0</span> and removed in <span class="Ux">FreeBSD + 16.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">Public key support is not implemented.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">October 31, 2025</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |