233 lines
8.2 KiB
HTML
Executable File
233 lines
8.2 KiB
HTML
Executable File
<?xml version="1.0" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>OPENSSL_s390xcap</title>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<link rev="made" href="mailto:root@localhost" />
|
|
</head>
|
|
|
|
<body style="background-color: white">
|
|
|
|
|
|
<!-- INDEX BEGIN -->
|
|
<div name="index">
|
|
<p><a name="__index__"></a></p>
|
|
|
|
<ul>
|
|
|
|
<li><a href="#name">NAME</a></li>
|
|
<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
<li><a href="#description">DESCRIPTION</a></li>
|
|
<li><a href="#return_values">RETURN VALUES</a></li>
|
|
<li><a href="#examples">EXAMPLES</a></li>
|
|
<li><a href="#see_also">SEE ALSO</a></li>
|
|
<li><a href="#copyright">COPYRIGHT</a></li>
|
|
</ul>
|
|
|
|
<hr name="index" />
|
|
</div>
|
|
<!-- INDEX END -->
|
|
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="name">NAME</a></h1>
|
|
<p>OPENSSL_s390xcap - the IBM z processor capabilities vector</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
|
<pre>
|
|
env OPENSSL_s390xcap=... <application></pre>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
|
<p>libcrypto supports z/Architecture instruction set extensions. These
|
|
extensions are denoted by individual bits in the capabilities vector.
|
|
When libcrypto is initialized, the bits returned by the STFLE instruction
|
|
and by the QUERY functions are stored in the vector.</p>
|
|
<p>To change the set of instructions available to an application, you can
|
|
set the <strong>OPENSSL_s390xcap</strong> environment variable before you start the
|
|
application. After initialization, the capability vector is ANDed bitwise
|
|
with a mask which is derived from the environment variable.</p>
|
|
<p>The environment variable is a semicolon-separated list of tokens which is
|
|
processed from left to right (whitespace is ignored):</p>
|
|
<pre>
|
|
OPENSSL_s390xcap="<tok1>;<tok2>;..."</pre>
|
|
<p>There are three types of tokens:</p>
|
|
<dl>
|
|
<dt><strong><a name="string" class="item"><string></a></strong></dt>
|
|
|
|
<dd>
|
|
<p>The name of a processor generation. A bit in the environment variable's
|
|
mask is set to one if and only if the specified processor generation
|
|
implements the corresponding instruction set extension. Possible values
|
|
are <strong>z900</strong>, <strong>z990</strong>, <strong>z9</strong>, <strong>z10</strong>, <strong>z196</strong>, <strong>zEC12</strong>, <strong>z13</strong>, <strong>z14</strong>
|
|
and <strong>z15</strong>.</p>
|
|
</dd>
|
|
<dt><strong><a name="string_mask_mask" class="item"><string>:<mask>:<mask></a></strong></dt>
|
|
|
|
<dd>
|
|
<p>The name of an instruction followed by two 64-bit masks. The part of the
|
|
environment variable's mask corresponding to the specified instruction is
|
|
set to the specified 128-bit mask. Possible values are <strong>kimd</strong>, <strong>klmd</strong>,
|
|
<strong>km</strong>, <strong>kmc</strong>, <strong>kmac</strong>, <strong>kmctr</strong>, <strong>kmo</strong>, <strong>kmf</strong>, <strong>prno</strong>, <strong>kma</strong>, <strong>pcc</strong>
|
|
and <strong>kdsa</strong>.</p>
|
|
</dd>
|
|
<dt><strong><a name="stfle_mask_mask_mask" class="item">stfle:<mask>:<mask>:<mask></a></strong></dt>
|
|
|
|
<dd>
|
|
<p>Store-facility-list-extended (stfle) followed by three 64-bit masks. The
|
|
part of the environment variable's mask corresponding to the stfle
|
|
instruction is set to the specified 192-bit mask.</p>
|
|
</dd>
|
|
</dl>
|
|
<p>The 64-bit masks are specified in hexadecimal notation. The 0x prefix is
|
|
optional. Prefix a mask with a tilde, <code>~</code>, to denote a bitwise NOT operation.</p>
|
|
<p>The following is a list of significant bits for each instruction. Colon
|
|
rows separate the individual 64-bit masks. The bit numbers in the first
|
|
column are consistent with [1], that is, 0 denotes the leftmost bit and
|
|
the numbering is continuous across 64-bit mask boundaries.</p>
|
|
<pre>
|
|
Bit Mask Facility/Function</pre>
|
|
<pre>
|
|
stfle:
|
|
# 17 1<<46 message-security assist
|
|
# 25 1<<38 store-clock-fast facility
|
|
:
|
|
# 76 1<<51 message-security assist extension 3
|
|
# 77 1<<50 message-security assist extension 4
|
|
:
|
|
#129 1<<62 vector facility
|
|
#134 1<<57 vector packed decimal facility
|
|
#135 1<<56 vector enhancements facility 1
|
|
#146 1<<45 message-security assist extension 8
|
|
#155 1<<36 message-security assist extension 9</pre>
|
|
<pre>
|
|
kimd :
|
|
# 1 1<<62 KIMD-SHA-1
|
|
# 2 1<<61 KIMD-SHA-256
|
|
# 3 1<<60 KIMD-SHA-512
|
|
# 32 1<<31 KIMD-SHA3-224
|
|
# 33 1<<30 KIMD-SHA3-256
|
|
# 34 1<<29 KIMD-SHA3-384
|
|
# 35 1<<28 KIMD-SHA3-512
|
|
# 36 1<<27 KIMD-SHAKE-128
|
|
# 37 1<<26 KIMD-SHAKE-256
|
|
:
|
|
# 65 1<<62 KIMD-GHASH</pre>
|
|
<pre>
|
|
klmd :
|
|
# 32 1<<31 KLMD-SHA3-224
|
|
# 33 1<<30 KLMD-SHA3-256
|
|
# 34 1<<29 KLMD-SHA3-384
|
|
# 35 1<<28 KLMD-SHA3-512
|
|
# 36 1<<27 KLMD-SHAKE-128
|
|
# 37 1<<26 KLMD-SHAKE-256
|
|
:</pre>
|
|
<pre>
|
|
km :
|
|
# 18 1<<45 KM-AES-128
|
|
# 19 1<<44 KM-AES-192
|
|
# 20 1<<43 KM-AES-256
|
|
# 50 1<<13 KM-XTS-AES-128
|
|
# 52 1<<11 KM-XTS-AES-256
|
|
:</pre>
|
|
<pre>
|
|
kmc :
|
|
# 18 1<<45 KMC-AES-128
|
|
# 19 1<<44 KMC-AES-192
|
|
# 20 1<<43 KMC-AES-256
|
|
:</pre>
|
|
<pre>
|
|
kmac :
|
|
# 18 1<<45 KMAC-AES-128
|
|
# 19 1<<44 KMAC-AES-192
|
|
# 20 1<<43 KMAC-AES-256
|
|
:</pre>
|
|
<pre>
|
|
kmctr:
|
|
:</pre>
|
|
<pre>
|
|
kmo :
|
|
# 18 1<<45 KMO-AES-128
|
|
# 19 1<<44 KMO-AES-192
|
|
# 20 1<<43 KMO-AES-256
|
|
:</pre>
|
|
<pre>
|
|
kmf :
|
|
# 18 1<<45 KMF-AES-128
|
|
# 19 1<<44 KMF-AES-192
|
|
# 20 1<<43 KMF-AES-256
|
|
:</pre>
|
|
<pre>
|
|
prno :
|
|
:</pre>
|
|
<pre>
|
|
kma :
|
|
# 18 1<<45 KMA-GCM-AES-128
|
|
# 19 1<<44 KMA-GCM-AES-192
|
|
# 20 1<<43 KMA-GCM-AES-256
|
|
:</pre>
|
|
<pre>
|
|
pcc :
|
|
:
|
|
# 64 1<<63 PCC-Scalar-Multiply-P256
|
|
# 65 1<<62 PCC-Scalar-Multiply-P384
|
|
# 66 1<<61 PCC-Scalar-Multiply-P521
|
|
# 72 1<<55 PCC-Scalar-Multiply-Ed25519
|
|
# 73 1<<54 PCC-Scalar-Multiply-Ed448
|
|
# 80 1<<47 PCC-Scalar-Multiply-X25519
|
|
# 81 1<<46 PCC-Scalar-Multiply-X448</pre>
|
|
<pre>
|
|
kdsa :
|
|
# 1 1<<62 KDSA-ECDSA-Verify-P256
|
|
# 2 1<<61 KDSA-ECDSA-Verify-P384
|
|
# 3 1<<60 KDSA-ECDSA-Verify-P521
|
|
# 9 1<<54 KDSA-ECDSA-Sign-P256
|
|
# 10 1<<53 KDSA-ECDSA-Sign-P384
|
|
# 11 1<<52 KDSA-ECDSA-Sign-P521
|
|
# 32 1<<31 KDSA-EdDSA-Verify-Ed25519
|
|
# 36 1<<27 KDSA-EdDSA-Verify-Ed448
|
|
# 40 1<<23 KDSA-EdDSA-Sign-Ed25519
|
|
# 44 1<<19 KDSA-EdDSA-Sign-Ed448
|
|
:</pre>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="return_values">RETURN VALUES</a></h1>
|
|
<p>Not available.</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="examples">EXAMPLES</a></h1>
|
|
<p>Disables all instruction set extensions which the z196 processor does not implement:</p>
|
|
<pre>
|
|
OPENSSL_s390xcap="z196"</pre>
|
|
<p>Disables the vector facility:</p>
|
|
<pre>
|
|
OPENSSL_s390xcap="stfle:~0:~0:~0x4000000000000000"</pre>
|
|
<p>Disables the KM-XTS-AES and and the KIMD-SHAKE function codes:</p>
|
|
<pre>
|
|
OPENSSL_s390xcap="km:~0x2800:~0;kimd:~0xc000000:~0"</pre>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="see_also">SEE ALSO</a></h1>
|
|
<p>[1] z/Architecture Principles of Operation, SA22-7832-12</p>
|
|
<p>
|
|
</p>
|
|
<hr />
|
|
<h1><a name="copyright">COPYRIGHT</a></h1>
|
|
<p>Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.</p>
|
|
<p>Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
<a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
|
|
|
</body>
|
|
|
|
</html>
|