share/man/man3c/setkey.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH SETKEY 3C "Aug 14, 2002"
  47 .SH NAME
  48 setkey \- set encoding key
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdlib.h>
  53
  54 \fBvoid\fR \fBsetkey\fR(\fBconst char *\fR\fIkey\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBsetkey()\fR function provides (rather primitive) access to the hashing
  61 algorithm employed by the \fBcrypt\fR(3C) function. The argument of
  62 \fBsetkey()\fR is an array of length 64 bytes containing only the bytes with
  63 numerical value of 0 and 1. If this string is divided into groups of 8, the
  64 low-order bit in each group is ignored; this gives a 56-bit key which is used
  65 by the algorithm. This is the key that will be used with the algorithm to
  66 encode a string \fIblock\fR passed to \fBencrypt\fR(3C).
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 No values are returned.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBsetkey()\fR function will fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBENOSYS\fR\fR
  79 .ad
  80 .RS 10n
  81 The functionality is not supported on this implementation.
  82 .RE
  83
  84 .SH USAGE
  85 .sp
  86 .LP
  87 In some environments, decoding may not be implemented.  This is related to U.S.
  88 Government restrictions on encryption and decryption routines: the \fBDES\fR
  89 decryption algorithm cannot be exported outside the U.S.A. Historical practice
  90 has been to ship a different version of the encryption library without the
  91 decryption feature in the routines supplied. Thus the exported version of
  92 \fBencrypt()\fR does encoding but not decoding.
  93 .sp
  94 .LP
  95 Because \fBsetkey()\fR does not return a value, applications wishing to check
  96 for errors should set \fBerrno\fR to 0, call \fBsetkey()\fR, then test
  97 \fBerrno\fR and, if it is non-zero, assume an error has occurred.
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Standard
 112 _
 113 MT-Level        Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBcrypt\fR(3C), \fBencrypt\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)