usr/src/man/man1m/wanboot_keymgmt.1m

   1 '\" te
   2 .\" Copyright (c) 2003, 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH WANBOOT_KEYMGMT 1M "Apr 18, 2003"
   7 .SH NAME
   8 wanboot_keymgmt \- insert and extract keys
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/inet/wanboot/keymgmt\fR \fB-i\fR \fB-k\fR \fIkey_file\fR \fB-s\fR \fIkeystore\fR \fB-o\fR type=\fIkeytype\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/lib/inet/wanboot/keymgmt\fR \fB-x\fR \fB-f\fR \fIoutfile\fR \fB-s\fR \fIkeystore\fR \fB-o\fR type=\fIkeytype\fR
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBkeymgmt\fR utility has two purposes:
  24 .RS +4
  25 .TP
  26 .ie t \(bu
  27 .el o
  28 To take a raw key, stored in \fIkey_file\fR, and insert it in the repository
  29 specified by \fIkeystore\fR.
  30 .RE
  31 .RS +4
  32 .TP
  33 .ie t \(bu
  34 .el o
  35 To extract a key of a specified type from the repository specified by
  36 \fIkeystore\fR, depositing it in \fIoutfile\fR.
  37 .RE
  38 .sp
  39 .LP
  40 \fIoutfile\fR will be created if it does not already exist. The type of key
  41 being added or extracted is specified by \fIkeytype\fR and may have one of four
  42 values: \fB3des\fR, \fBaes\fR, \fBrsa\fR, or \fBsha1\fR (the last used by HMAC
  43 SHA-1). When extracting a key, the first key with an OID matching the supplied
  44 type is used.
  45 .SH ARGUMENTS
  46 .sp
  47 .LP
  48 The following arguments are supported:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fB-i\fR\fR
  53 .ad
  54 .RS 19n
  55 Used in conjunction with \fB-k\fR to insert a raw key in \fIkeystore\fR.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-f\fR \fIoutfile\fR\fR
  62 .ad
  63 .RS 19n
  64 Used to specify a file to receive an extracted key.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB-k\fR \fIkey_file\fR\fR
  71 .ad
  72 .RS 19n
  73 Used in conjunction with \fB-i\fR to specify the file in which a raw key is
  74 stored. This key will be inserted in \fIkeystore\fR.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-o\fR type=\fIkeytype\fR\fR
  81 .ad
  82 .RS 19n
  83 Specifies the type of key being inserted or extracted. Must be one of
  84 \fB3des\fR, \fBaes\fR, \fBrsa\fR, or \fBsha1\fR.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-s\fR \fIkeystore\fR\fR
  91 .ad
  92 .RS 19n
  93 Specifies a repository in which a key will be inserted or from which a key will
  94 be extracted.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-x\fR\fR
 101 .ad
 102 .RS 19n
 103 Used in conjunction with \fB-f\fR to extract a key of a specified type and
 104 deposit it in \fIoutfile\fR.
 105 .RE
 106
 107 .SH EXIT STATUS
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB0\fR\fR
 112 .ad
 113 .RS 6n
 114 Successful operation.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB>0\fR\fR
 121 .ad
 122 .RS 6n
 123 An error occurred.
 124 .RE
 125
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Interface Stability     Obsolete
 140 .TE
 141
 142 .SH SEE ALSO
 143 .sp
 144 .LP
 145 \fBattributes\fR(5)
 146 .sp
 147 .LP
 148 ITU-T Recommendation X.208