136 lines
4.7 KiB
HTML
136 lines
4.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>setkey</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="setkey"></a> <a name="tag_03_654"></a><!-- setkey -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_654_01"></a>NAME</h4>
|
|
|
|
<blockquote>setkey - set encoding key (<b>CRYPT</b>)</blockquote>
|
|
|
|
<h4><a name="tag_03_654_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<div class="box"><code><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt=
|
|
"[Option Start]" border="0"> #include <<a href="../basedefs/stdlib.h.html">stdlib.h</a>><br>
|
|
<br>
|
|
void setkey(const char *</tt><i>key</i><tt>); <img src="../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
|
|
|
|
<tt><br>
|
|
</tt></blockquote>
|
|
|
|
<h4><a name="tag_03_654_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>setkey</i>() function provides access to an implementation-defined encoding algorithm. The argument of <i>setkey</i>() is
|
|
an array of length 64 bytes containing only the bytes with numerical value of 0 and 1. If this string is divided into groups of 8,
|
|
the low-order bit in each group is ignored; this gives a 56-bit key which is used by the algorithm. This is the key that shall be
|
|
used with the algorithm to encode a string <i>block</i> passed to <a href="../functions/encrypt.html"><i>encrypt</i>()</a>.</p>
|
|
|
|
<p>The <i>setkey</i>() function shall not change the setting of <i>errno</i> if successful. An application wishing to check for
|
|
error situations should set <i>errno</i> to 0 before calling <i>setkey</i>(). If <i>errno</i> is non-zero on return, an error has
|
|
occurred.</p>
|
|
|
|
<p>The <i>setkey</i>() function need not be reentrant. A function that is not required to be reentrant is not required to be
|
|
thread-safe.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>No values are returned.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>setkey</i>() function shall fail if:</p>
|
|
|
|
<dl compact>
|
|
<dt>[ENOSYS]</dt>
|
|
|
|
<dd>The functionality is not supported on this implementation.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_654_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>Decoding need not be implemented in all environments. This is related to government restrictions in some countries on encryption
|
|
and decryption routines. Historical practice has been to ship a different version of the encryption library without the decryption
|
|
feature in the routines supplied. Thus the exported version of <a href="../functions/encrypt.html"><i>encrypt</i>()</a> does
|
|
encoding but not decoding.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="crypt.html"><i>crypt</i>()</a> , <a href="encrypt.html"><i>encrypt</i>()</a> , the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/stdlib.h.html"><i><stdlib.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 1. Derived from Issue 1 of the SVID.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_654_12"></a>Issue 5</h4>
|
|
|
|
<blockquote>
|
|
<p>The DESCRIPTION is updated to indicate that <i>errno</i> is not changed if the function is successful.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|