removed prng.c from libfreeswan
[strongswan.git] / src / libfreeswan / atosa.3
1 .TH IPSEC_ATOSA 3 "11 June 2001"
2 .SH NAME
3 ipsec atosa, satoa \- convert IPsec Security Association IDs to and from ASCII
4 .SH SYNOPSIS
5 .B "#include <freeswan.h>
6 .sp
7 .B "const char *atosa(const char *src, size_t srclen,"
8 .ti +1c
9 .B "struct sa_id *sa);
10 .br
11 .B "size_t satoa(struct sa_id sa, int format,"
12 .ti +1c
13 .B "char *dst, size_t dstlen);"
14 .sp
15 .B "struct sa_id {"
16 .ti +1c
17 .B "struct in_addr dst;"
18 .ti +1c
19 .B "ipsec_spi_t spi;"
20 .ti +1c
21 .B "int proto;"
22 .br
23 .B "};"
24 .SH DESCRIPTION
25 These functions are obsolete; see
26 .IR ipsec_ttosa (3)
27 for their replacements.
28 .PP
29 .I Atosa
30 converts an ASCII Security Association (SA) specifier into an
31 .B sa_id
32 structure (containing
33 a destination-host address
34 in network byte order,
35 an SPI number in network byte order, and
36 a protocol code).
37 .I Satoa
38 does the reverse conversion, back to an ASCII SA specifier.
39 .PP
40 An SA is specified in ASCII with a mail-like syntax, e.g.
41 .BR esp507@1.2.3.4 .
42 An SA specifier contains
43 a protocol prefix (currently
44 .BR ah ,
45 .BR esp ,
46 or
47 .BR tun ),
48 an unsigned integer SPI number,
49 and an IP address.
50 The SPI number can be decimal or hexadecimal
51 (with
52 .B 0x
53 prefix), as accepted by
54 .IR ipsec_atoul (3).
55 The IP address can be any form accepted by
56 .IR ipsec_atoaddr (3),
57 e.g. dotted-decimal address or DNS name.
58 .PP
59 As a special case, the SA specifier
60 .B %passthrough
61 signifies the special SA used to indicate that packets should be
62 passed through unaltered.
63 (At present, this is a synonym for
64 .BR tun0x0@0.0.0.0 ,
65 but that is subject to change without notice.)
66 This form is known to both
67 .I atosa
68 and
69 .IR satoa ,
70 so the internal form of
71 .B %passthrough
72 is never visible.
73 .PP
74 The
75 .B <freeswan.h>
76 header file supplies the
77 .B sa_id
78 structure, as well as a data type
79 .B ipsec_spi_t
80 which is an unsigned 32-bit integer.
81 (There is no consistency between kernel and user on what such a type
82 is called, hence the header hides the differences.)
83 .PP
84 The protocol code uses the same numbers that IP does.
85 For user convenience, given the difficulty in acquiring the exact set of
86 protocol names used by the kernel,
87 .B <freeswan.h>
88 defines the names
89 .BR SA_ESP ,
90 .BR SA_AH ,
91 and
92 .B SA_IPIP
93 to have the same values as the kernel names
94 .BR IPPROTO_ESP ,
95 .BR IPPROTO_AH ,
96 and
97 .BR IPPROTO_IPIP .
98 .PP
99 The
100 .I srclen
101 parameter of
102 .I atosa
103 specifies the length of the ASCII string pointed to by
104 .IR src ;
105 it is an error for there to be anything else
106 (e.g., a terminating NUL) within that length.
107 As a convenience for cases where an entire NUL-terminated string is
108 to be converted,
109 a
110 .I srclen
111 value of
112 .B 0
113 is taken to mean
114 .BR strlen(src) .
115 .PP
116 The
117 .I dstlen
118 parameter of
119 .I satoa
120 specifies the size of the
121 .I dst
122 parameter;
123 under no circumstances are more than
124 .I dstlen
125 bytes written to
126 .IR dst .
127 A result which will not fit is truncated.
128 .I Dstlen
129 can be zero, in which case
130 .I dst
131 need not be valid and no result is written,
132 but the return value is unaffected;
133 in all other cases, the (possibly truncated) result is NUL-terminated.
134 The
135 .I freeswan.h
136 header file defines a constant,
137 .BR SATOA_BUF ,
138 which is the size of a buffer just large enough for worst-case results.
139 .PP
140 The
141 .I format
142 parameter of
143 .I satoa
144 specifies what format is to be used for the conversion.
145 The value
146 .B 0
147 (not the ASCII character
148 .BR '0' ,
149 but a zero value)
150 specifies a reasonable default
151 (currently
152 lowercase protocol prefix, lowercase hexadecimal SPI, dotted-decimal address).
153 The value
154 .B d
155 causes the SPI to be generated in decimal instead.
156 .PP
157 .I Atosa
158 returns
159 .B NULL
160 for success and
161 a pointer to a string-literal error message for failure;
162 see DIAGNOSTICS.
163 .I Satoa
164 returns
165 .B 0
166 for a failure, and otherwise
167 always returns the size of buffer which would 
168 be needed to
169 accommodate the full conversion result, including terminating NUL;
170 it is the caller's responsibility to check this against the size of
171 the provided buffer to determine whether truncation has occurred.
172 .SH SEE ALSO
173 ipsec_atoul(3), ipsec_atoaddr(3), inet(3)
174 .SH DIAGNOSTICS
175 Fatal errors in
176 .I atosa
177 are:
178 empty input;
179 input too small to be a legal SA specifier;
180 no
181 .B @
182 in input;
183 unknown protocol prefix;
184 conversion error in
185 .I atoul
186 or
187 .IR atoaddr .
188 .PP
189 Fatal errors in
190 .I satoa
191 are:
192 unknown format; unknown protocol code.
193 .SH HISTORY
194 Written for the FreeS/WAN project by Henry Spencer.
195 .SH BUGS
196 The
197 .B tun
198 protocol code is a FreeS/WANism which may eventually disappear.
199 .PP
200 The restriction of ASCII-to-binary error reports to literal strings
201 (so that callers don't need to worry about freeing them or copying them)
202 does limit the precision of error reporting.
203 .PP
204 The ASCII-to-binary error-reporting convention lends itself
205 to slightly obscure code,
206 because many readers will not think of NULL as signifying success.
207 A good way to make it clearer is to write something like:
208 .PP
209 .RS
210 .nf
211 .B "const char *error;"
212 .sp
213 .B "error = atoaddr( /* ... */ );"
214 .B "if (error != NULL) {"
215 .B "        /* something went wrong */"
216 .fi
217 .RE