1 .\" Copyright (c) 1998 Dag-Erling Coïdan Smørgrav
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/lib/libfetch/fetch.3,v 1.11.2.29 2003/06/13 14:36:58 trhodes Exp $
26 .\" $DragonFly: src/lib/libfetch/fetch.3,v 1.2 2003/06/17 04:26:49 dillon Exp $
60 .Nd file transfer functions
68 .Fn fetchMakeURL "const char *scheme" "const char *host" "int port" "const char *doc" "const char *user" "const char *pwd"
70 .Fn fetchParseURL "const char *URL"
72 .Fn fetchFreeURL "struct url *u"
74 .Fn fetchXGetURL "const char *URL" "struct url_stat *us" "const char *flags"
76 .Fn fetchGetURL "const char *URL" "const char *flags"
78 .Fn fetchPutURL "const char *URL" "const char *flags"
80 .Fn fetchStatURL "const char *URL" "struct url_stat *us" "const char *flags"
82 .Fn fetchListURL "const char *URL" "const char *flags"
84 .Fn fetchXGet "struct url *u" "struct url_stat *us" "const char *flags"
86 .Fn fetchGet "struct url *u" "const char *flags"
88 .Fn fetchPut "struct url *u" "const char *flags"
90 .Fn fetchStat "struct url *u" "struct url_stat *us" "const char *flags"
92 .Fn fetchList "struct url *u" "const char *flags"
94 .Fn fetchXGetFile "struct url *u" "struct url_stat *us" "const char *flags"
96 .Fn fetchGetFile "struct url *u" "const char *flags"
98 .Fn fetchPutFile "struct url *u" "const char *flags"
100 .Fn fetchStatFile "struct url *u" "struct url_stat *us" "const char *flags"
102 .Fn fetchListFile "struct url *u" "const char *flags"
104 .Fn fetchXGetHTTP "struct url *u" "struct url_stat *us" "const char *flags"
106 .Fn fetchGetHTTP "struct url *u" "const char *flags"
108 .Fn fetchPutHTTP "struct url *u" "const char *flags"
110 .Fn fetchStatHTTP "struct url *u" "struct url_stat *us" "const char *flags"
112 .Fn fetchListHTTP "struct url *u" "const char *flags"
114 .Fn fetchXGetFTP "struct url *u" "struct url_stat *us" "const char *flags"
116 .Fn fetchGetFTP "struct url *u" "const char *flags"
118 .Fn fetchPutFTP "struct url *u" "const char *flags"
120 .Fn fetchStatFTP "struct url *u" "struct url_stat *us" "const char *flags"
122 .Fn fetchListFTP "struct url *u" "const char *flags"
124 These functions implement a high-level library for retrieving and
125 uploading files using Uniform Resource Locators (URLs).
128 takes a URL in the form of a null-terminated string and splits it into
129 its components function according to the Common Internet Scheme Syntax
131 A regular expression which produces this syntax is:
133 <scheme>:(//(<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
136 If the URL does not seem to begin with a scheme name, the following
139 ((<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
142 Note that some components of the URL are not necessarily relevant to
144 For instance, the file scheme only needs the <scheme> and <document>
150 return a pointer to a
152 structure, which is defined as follows in
155 #define URL_SCHEMELEN 16
156 #define URL_USERLEN 256
157 #define URL_PWDLEN 256
160 char scheme[URL_SCHEMELEN+1];
161 char user[URL_USERLEN+1];
162 char pwd[URL_PWDLEN+1];
163 char host[MAXHOSTNAMELEN+1];
171 The pointer returned by
175 should be freed using
182 constitute the recommended interface to the
185 They examine the URL passed to them to determine the transfer
186 method, and call the appropriate lower-level functions to perform the
189 also returns the remote document's metadata in the
191 structure pointed to by the
197 argument is a string of characters which specify transfer options.
199 meaning of the individual flags is scheme-dependent, and is detailed
200 in the appropriate section below.
203 attempts to obtain the requested document's metadata and fill in the
204 structure pointed to by its second argument.
207 structure is defined as follows in
217 If the size could not be obtained from the server, the
220 If the modification time could not be obtained from the server, the
222 field is set to the epoch.
223 If the access time could not be obtained from the server, the
225 field is set to the modification time.
228 attempts to list the contents of the directory pointed to by the URL
230 If successful, it returns a malloced array of
235 structure is defined as follows in
239 char name[MAXPATHLEN];
240 struct url_stat stat;
244 The list is terminated by an entry with an empty name.
246 The pointer returned by
248 should be freed using
262 except that they expect a pre-parsed URL in the form of a pointer to
265 rather than a string.
272 functions return a pointer to a stream which can be used to read or
273 write data from or to the requested document, respectively.
275 although the implementation details of the individual access methods
276 vary, it can generally be assumed that a stream returned by one of the
280 functions is read-only, and that a stream returned by one of the
282 functions is write-only.
288 provide access to documents which are files in a locally mounted file
290 Only the <document> component of the URL is used.
295 do not accept any flags.
300 (append to file) flag.
301 If that flag is specified, the data written to
302 the stream returned by
304 will be appended to the previous contents of the file, instead of
311 implement the FTP protocol as described in RFC959.
315 (passive) flag is specified, a passive (rather than active) connection
320 (low) flag is specified, data sockets will be allocated in the low (or
321 default) port range instead of the high port range (see
326 (direct) flag is specified,
331 will use a direct connection even if a proxy server is defined.
333 If no user name or password is given, the
335 library will attempt an anonymous login, with user name "anonymous"
336 and password "anonymous@<hostname>".
343 functions implement the HTTP/1.1 protocol.
344 With a little luck, there's
345 even a chance that they comply with RFC2616 and RFC2617.
349 (direct) flag is specified,
354 will use a direct connection even if a proxy server is defined.
356 Since there seems to be no good way of implementing the HTTP PUT
357 method in a manner consistent with the rest of the
361 is currently unimplemented.
363 Apart from setting the appropriate environment variables and
364 specifying the user name and password in the URL or the
366 the calling program has the option of defining an authentication
367 function with the following prototype:
370 .Fn myAuthMethod "struct url *u"
372 The callback function should fill in the
376 fields in the provided
378 and return 0 on success, or any other value to indicate failure.
380 To register the authentication callback, simply set
383 The callback will be used whenever a site requires authentication and
384 the appropriate environment variables aren't set.
386 This interface is experimental and may be subject to change.
389 returns a pointer to a
391 containing the individual components of the URL.
393 unable to allocate memory, or the URL is syntactically incorrect,
395 returns a NULL pointer.
399 functions return 0 on success and -1 on failure.
401 All other functions return a stream pointer which may be used to
402 access the requested document, or NULL if an error occurred.
404 The following error codes are defined in
407 .It Bq Er FETCH_ABORT
410 Authentication failed
413 .It Bq Er FETCH_EXISTS
418 Informational response
419 .It Bq Er FETCH_MEMORY
421 .It Bq Er FETCH_MOVED
423 .It Bq Er FETCH_NETWORK
427 .It Bq Er FETCH_PROTO
429 .It Bq Er FETCH_RESOLV
431 .It Bq Er FETCH_SERVER
435 .It Bq Er FETCH_TIMEOUT
437 .It Bq Er FETCH_UNAVAIL
438 File is not available
439 .It Bq Er FETCH_UNKNOWN
445 The accompanying error message includes a protocol-specific error code
446 and message, e.g. "File is not available (404 Not Found)"
448 .Bl -tag -width ".Ev FETCH_BIND_ADDRESS"
449 .It Ev FETCH_BIND_ADDRESS
450 Specifies a hostname or IP address to which sockets used for outgoing
451 connections will be bound.
453 Default FTP login if none was provided in the URL.
454 .It Ev FTP_PASSIVE_MODE
455 If set to anything but
457 forces the FTP code to use passive mode.
459 Default FTP password if the remote server requests one and none was
462 URL of the proxy to use for FTP requests.
463 The document part is ignored.
464 FTP and HTTP proxies are supported; if no scheme is specified, FTP is
466 If the proxy is an FTP proxy,
470 as user name to the proxy, where
472 is the real user name, and
474 is the name of the FTP server.
476 If this variable is set to an empty string, no proxy will be used for
477 FTP requests, even if the
485 Specifies HTTP authorization parameters as a colon-separated list of
487 The first and second item are the authorization scheme and realm
488 respectively; further items are scheme-dependent.
489 Currently, only basic authorization is supported.
491 Basic authorization requires two parameters: the user name and
492 password, in that order.
494 This variable is only used if the server requires authorization and
495 no user name or password was specified in the URL.
497 URL of the proxy to use for HTTP requests.
498 The document part is ignored.
499 Only HTTP proxies are supported for HTTP requests.
500 If no port number is specified, the default is 3128.
502 Note that this proxy will also be used for FTP documents, unless the
509 .It Ev HTTP_PROXY_AUTH
510 Specifies authorization parameters for the HTTP proxy in the same
515 This variable is used if and only if connected to an HTTP proxy, and
516 is ignored if a user and/or a password were specified in the proxy
519 Specifies the referrer URL to use for HTTP requests.
522 the document URL will be used as referrer URL.
523 .It Ev HTTP_USER_AGENT
524 Specifies the User-Agent string to use for HTTP requests.
525 This can be useful when working with HTTP origin or proxy servers that
526 differentiate between user agents.
528 Specifies a file to use instead of
530 to look up login names and passwords for FTP sites.
533 for a description of the file format.
534 This feature is experimental.
537 To access a proxy server on
538 .Pa proxy.example.com
541 environment variable in a manner similar to this:
543 .Dl HTTP_PROXY=http://proxy.example.com:8080
545 If the proxy server requires authentication, there are
546 two options available for passing the authentication data.
547 The first method is by using the proxy URL:
549 .Dl HTTP_PROXY=http://<user>:<pwd>@proxy.example.com:8080
551 The second method is by using the
553 environment variable:
554 .Bd -literal -offset indent
555 HTTP_PROXY=http://proxy.example.com:8080
556 HTTP_PROXY_AUTH=basic:*:<user>:<pwd>
566 .%B File Transfer Protocol
574 .%T How to Use Anonymous FTP
582 .%T Uniform Resource Locators (URL)
594 .%B Hypertext Transfer Protocol -- HTTP/1.1
606 .%B HTTP Authentication: Basic and Digest Access Authentication
612 library first appeared in
618 library was mostly written by
619 .An Dag-Erling Co\(:idan Sm\(/orgrav Aq des@FreeBSD.org
620 with numerous suggestions from
621 .An Jordan K. Hubbard Aq jkh@FreeBSD.org ,
622 .An Eugene Skepner Aq eu@qub.com
626 It replaces the older
629 .An Poul-Henning Kamp Aq pkh@FreeBSD.org
631 .An Jordan K. Hubbard Aq jkh@FreeBSD.org .
633 This manual page was written by
634 .An Dag-Erling Co\(:idan Sm\(/orgrav Aq des@FreeBSD.org .
636 Some parts of the library are not yet implemented.
642 and FTP proxy support.
644 There's no way to select a proxy at run-time other than setting the
648 environment variables as appropriate.
651 does not understand or obey 305 (Use Proxy) replies.
653 Error numbers are unique only within a certain context; the error
654 codes used for FTP and HTTP overlap, as do those used for resolver and
656 For instance, error code 202 means "Command not
657 implemented, superfluous at this site" in an FTP context and
658 "Accepted" in an HTTP context.
661 does not check that the result of an MDTM command is a valid date.
663 The man page is incomplete, poorly written and produces badly
666 The error reporting mechanism is unsatisfactory.
668 Some parts of the code are not fully reentrant.