and added files
[bcm963xx.git] / userapps / opensource / ipsec-tools / src / racoon / plainrsa-gen.8
1 .\" $Id: plainrsa-gen.8,v 1.2 2004/07/12 20:43:50 ludvigm Exp $
2 .\"
3 .\" Copyright (C) 2004 SuSE Linux AG, Nuernberg, Germany.
4 .\" Contributed by: Michal Ludvig <mludvig@suse.cz>, SUSE Labs
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the project nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .Dd Jun 14, 2004
32 .Dt plainrsa-gen 8
33 .Os IPsec-tools
34 \"
35 .Sh NAME
36 .Nm plainrsa-gen
37 .Nd Generator of Plain RSA keys
38 .\"
39 .Sh SYNOPSIS
40 .Nm plainrsa-gen
41 .Bk -words
42 .Op Fl b Ar bits
43 .Op Fl e Ar pubexp
44 .Op Fl f Ar outfile
45 .Op Fl h
46 .Ek
47 .\"
48 .Sh DESCRIPTION
49 .Nm
50 can be used to generate 
51 .Pa Plain RSA keys
52 for authentication purposes. Using 
53 .Pa Plain RSA keys
54 is optional. Other possibilities are
55 .Pa Preshared keys
56 or
57 .Pa X.509 certificates .
58 .\"
59 .Bl -tag -width Ds
60 .It Fl b Ar bits
61 bit length of the key. Default is 
62 .Pa 1024 ,
63 recommended length is
64 .Pa 2048
65 or even
66 .Pa 4096
67 bits. Note that generating longer keys takes longer time.
68 .It Fl e Ar pubexp
69 value of RSA public exponent. Default is
70 .Pa 0x3 .
71 Don't change unless you really know what you are doing!
72 .It Fl f Ar outfile
73 write the resulting key to 
74 .Pa outfile
75 instead of 
76 .Pa stdout .
77 If the file already exists it won't be overwritten. You wouldn't like to loose your private key by accident, would you?
78 .El
79 .\"
80 .Sh OUTPUT FILE FORMAT
81 This is the secter
82 .Pa private key
83 that should 
84 .Ic never
85 leave your computer:
86 .Bd -literal
87 : RSA   {
88         # RSA 1024 bits
89         # pubkey=0sAQOrWlcwbAIdNSMhDt...
90         Modulus: 0xab5a57306c021d3523...
91         PublicExponent: 0x03
92         PrivateExponent: 0x723c3a2048...
93         Prime1: 0xd309b30e6adf9d85c01...
94         Prime2: 0xcfdc2a8aa5b2b3c90e3...
95         Exponent1: 0x8cb122099c9513ae...
96         Exponent2: 0x8a92c7071921cd30...
97         Coefficient: 0x722751305eafe9...
98   }
99 .Ed
100 .Pp
101 The line
102 .Pa pubkey=0sAQOrW...
103 of the
104 .Pa private key
105 contains a 
106 .Pa public key
107 that should be stored in the other peer's configuration in this format:
108 .Bd -literal
109 : PUB 0sAQOrWlcwbAIdNSMhDt...
110 .Ed
111 .\"
112 .Pp
113 You can also specify 
114 .Pa from
115 and 
116 .Pa to
117 addresses for which the key is valid:
118 .Bd -literal
119 0.0.0.0/0 10.20.30.0/24 : PUB 0sAQOrWlcwbAIdNSMhDt...
120 .Ed
121 .\"
122 .Ed
123 .\"
124 .Sh SEE ALSO
125 .Xr racoon.conf 5
126 .Xr racoon 8
127 .\"
128 .Sh HISTORY
129 The
130 .Nm
131 written by 
132 .Pa Michal Ludvig <michal@logix.cz>
133 first appeared in 
134 .Ic ipsec-tools 0.4 .