2 .\" Copyright (c) 1998-2004 Dag-Erling Coïdan Smørgrav
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: src/lib/libfetch/fetch.3,v 1.66 2008/12/15 08:27:44 murray Exp $
27 .\" $DragonFly: src/lib/libfetch/fetch.3,v 1.5 2007/11/23 23:16:36 swildner Exp $
61 .Nd file transfer functions
69 .Fn fetchMakeURL "const char *scheme" "const char *host" "int port" "const char *doc" "const char *user" "const char *pwd"
71 .Fn fetchParseURL "const char *URL"
73 .Fn fetchFreeURL "struct url *u"
75 .Fn fetchXGetURL "const char *URL" "struct url_stat *us" "const char *flags"
77 .Fn fetchGetURL "const char *URL" "const char *flags"
79 .Fn fetchPutURL "const char *URL" "const char *flags"
81 .Fn fetchStatURL "const char *URL" "struct url_stat *us" "const char *flags"
83 .Fn fetchListURL "const char *URL" "const char *flags"
85 .Fn fetchXGet "struct url *u" "struct url_stat *us" "const char *flags"
87 .Fn fetchGet "struct url *u" "const char *flags"
89 .Fn fetchPut "struct url *u" "const char *flags"
91 .Fn fetchStat "struct url *u" "struct url_stat *us" "const char *flags"
93 .Fn fetchList "struct url *u" "const char *flags"
95 .Fn fetchXGetFile "struct url *u" "struct url_stat *us" "const char *flags"
97 .Fn fetchGetFile "struct url *u" "const char *flags"
99 .Fn fetchPutFile "struct url *u" "const char *flags"
101 .Fn fetchStatFile "struct url *u" "struct url_stat *us" "const char *flags"
103 .Fn fetchListFile "struct url *u" "const char *flags"
105 .Fn fetchXGetHTTP "struct url *u" "struct url_stat *us" "const char *flags"
107 .Fn fetchGetHTTP "struct url *u" "const char *flags"
109 .Fn fetchPutHTTP "struct url *u" "const char *flags"
111 .Fn fetchStatHTTP "struct url *u" "struct url_stat *us" "const char *flags"
113 .Fn fetchListHTTP "struct url *u" "const char *flags"
115 .Fn fetchXGetFTP "struct url *u" "struct url_stat *us" "const char *flags"
117 .Fn fetchGetFTP "struct url *u" "const char *flags"
119 .Fn fetchPutFTP "struct url *u" "const char *flags"
121 .Fn fetchStatFTP "struct url *u" "struct url_stat *us" "const char *flags"
123 .Fn fetchListFTP "struct url *u" "const char *flags"
125 These functions implement a high-level library for retrieving and
126 uploading files using Uniform Resource Locators (URLs).
129 takes a URL in the form of a null-terminated string and splits it into
130 its components function according to the Common Internet Scheme Syntax
131 detailed in RFC 1738.
132 A regular expression which produces this syntax is:
134 <scheme>:(//(<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
137 If the URL does not seem to begin with a scheme name, the following
140 ((<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
143 Note that some components of the URL are not necessarily relevant to
145 For instance, the file scheme only needs the <scheme> and <document>
151 return a pointer to a
153 structure, which is defined as follows in
156 #define URL_SCHEMELEN 16
157 #define URL_USERLEN 256
158 #define URL_PWDLEN 256
161 char scheme[URL_SCHEMELEN+1];
162 char user[URL_USERLEN+1];
163 char pwd[URL_PWDLEN+1];
164 char host[MAXHOSTNAMELEN+1];
175 field stores the time value for
176 .Li If-Modified-Since
179 The pointer returned by
183 should be freed using
190 constitute the recommended interface to the
193 They examine the URL passed to them to determine the transfer
194 method, and call the appropriate lower-level functions to perform the
197 also returns the remote document's metadata in the
199 structure pointed to by the
205 argument is a string of characters which specify transfer options.
207 meaning of the individual flags is scheme-dependent, and is detailed
208 in the appropriate section below.
211 attempts to obtain the requested document's metadata and fill in the
212 structure pointed to by its second argument.
215 structure is defined as follows in
225 If the size could not be obtained from the server, the
228 If the modification time could not be obtained from the server, the
230 field is set to the epoch.
231 If the access time could not be obtained from the server, the
233 field is set to the modification time.
236 attempts to list the contents of the directory pointed to by the URL
238 If successful, it returns a malloced array of
243 structure is defined as follows in
248 struct url_stat stat;
252 The list is terminated by an entry with an empty name.
254 The pointer returned by
256 should be freed using
270 except that they expect a pre-parsed URL in the form of a pointer to
273 rather than a string.
280 functions return a pointer to a stream which can be used to read or
281 write data from or to the requested document, respectively.
283 although the implementation details of the individual access methods
284 vary, it can generally be assumed that a stream returned by one of the
288 functions is read-only, and that a stream returned by one of the
290 functions is write-only.
296 provide access to documents which are files in a locally mounted file
298 Only the <document> component of the URL is used.
303 do not accept any flags.
308 (append to file) flag.
309 If that flag is specified, the data written to
310 the stream returned by
312 will be appended to the previous contents of the file, instead of
319 implement the FTP protocol as described in RFC 959.
323 (passive) flag is specified, a passive (rather than active) connection
328 (low) flag is specified, data sockets will be allocated in the low (or
329 default) port range instead of the high port range (see
334 (direct) flag is specified,
339 will use a direct connection even if a proxy server is defined.
341 If no user name or password is given, the
343 library will attempt an anonymous login, with user name "anonymous"
344 and password "anonymous@<hostname>".
351 functions implement the HTTP/1.1 protocol.
352 With a little luck, there is
353 even a chance that they comply with RFC 2616 and RFC 2617.
357 (direct) flag is specified,
362 will use a direct connection even if a proxy server is defined.
366 (if-modified-since) flag is specified, and
375 will send a conditional
376 .Li If-Modified-Since
377 HTTP header to only fetch the content if it is newer than
380 Since there seems to be no good way of implementing the HTTP PUT
381 method in a manner consistent with the rest of the
385 is currently unimplemented.
387 Apart from setting the appropriate environment variables and
388 specifying the user name and password in the URL or the
390 the calling program has the option of defining an authentication
391 function with the following prototype:
394 .Fn myAuthMethod "struct url *u"
396 The callback function should fill in the
400 fields in the provided
402 and return 0 on success, or any other value to indicate failure.
404 To register the authentication callback, simply set
407 The callback will be used whenever a site requires authentication and
408 the appropriate environment variables are not set.
410 This interface is experimental and may be subject to change.
413 returns a pointer to a
415 containing the individual components of the URL.
417 unable to allocate memory, or the URL is syntactically incorrect,
419 returns a NULL pointer.
423 functions return 0 on success and -1 on failure.
425 All other functions return a stream pointer which may be used to
426 access the requested document, or NULL if an error occurred.
428 The following error codes are defined in
431 .It Bq Er FETCH_ABORT
434 Authentication failed
437 .It Bq Er FETCH_EXISTS
442 Informational response
443 .It Bq Er FETCH_MEMORY
445 .It Bq Er FETCH_MOVED
447 .It Bq Er FETCH_NETWORK
451 .It Bq Er FETCH_PROTO
453 .It Bq Er FETCH_RESOLV
455 .It Bq Er FETCH_SERVER
459 .It Bq Er FETCH_TIMEOUT
461 .It Bq Er FETCH_UNAVAIL
462 File is not available
463 .It Bq Er FETCH_UNKNOWN
469 The accompanying error message includes a protocol-specific error code
470 and message, e.g.\& "File is not available (404 Not Found)"
472 .Bl -tag -width ".Ev FETCH_BIND_ADDRESS"
473 .It Ev FETCH_BIND_ADDRESS
474 Specifies a hostname or IP address to which sockets used for outgoing
475 connections will be bound.
477 Default FTP login if none was provided in the URL.
478 .It Ev FTP_PASSIVE_MODE
479 If set to anything but
481 forces the FTP code to use passive mode.
483 Default FTP password if the remote server requests one and none was
486 URL of the proxy to use for FTP requests.
487 The document part is ignored.
488 FTP and HTTP proxies are supported; if no scheme is specified, FTP is
490 If the proxy is an FTP proxy,
494 as user name to the proxy, where
496 is the real user name, and
498 is the name of the FTP server.
500 If this variable is set to an empty string, no proxy will be used for
501 FTP requests, even if the
509 Specifies HTTP authorization parameters as a colon-separated list of
511 The first and second item are the authorization scheme and realm
512 respectively; further items are scheme-dependent.
513 Currently, only basic authorization is supported.
515 Basic authorization requires two parameters: the user name and
516 password, in that order.
518 This variable is only used if the server requires authorization and
519 no user name or password was specified in the URL.
521 URL of the proxy to use for HTTP requests.
522 The document part is ignored.
523 Only HTTP proxies are supported for HTTP requests.
524 If no port number is specified, the default is 3128.
526 Note that this proxy will also be used for FTP documents, unless the
533 .It Ev HTTP_PROXY_AUTH
534 Specifies authorization parameters for the HTTP proxy in the same
539 This variable is used if and only if connected to an HTTP proxy, and
540 is ignored if a user and/or a password were specified in the proxy
543 Specifies the referrer URL to use for HTTP requests.
546 the document URL will be used as referrer URL.
547 .It Ev HTTP_USER_AGENT
548 Specifies the User-Agent string to use for HTTP requests.
549 This can be useful when working with HTTP origin or proxy servers that
550 differentiate between user agents.
552 Specifies a file to use instead of
554 to look up login names and passwords for FTP sites.
557 for a description of the file format.
558 This feature is experimental.
560 Either a single asterisk, which disables the use of proxies
561 altogether, or a comma- or whitespace-separated list of hosts for
562 which proxies should not be used.
569 To access a proxy server on
570 .Pa proxy.example.com
573 environment variable in a manner similar to this:
575 .Dl HTTP_PROXY=http://proxy.example.com:8080
577 If the proxy server requires authentication, there are
578 two options available for passing the authentication data.
579 The first method is by using the proxy URL:
581 .Dl HTTP_PROXY=http://<user>:<pwd>@proxy.example.com:8080
583 The second method is by using the
585 environment variable:
586 .Bd -literal -offset indent
587 HTTP_PROXY=http://proxy.example.com:8080
588 HTTP_PROXY_AUTH=basic:*:<user>:<pwd>
591 To disable the use of a proxy for an HTTP server running on the local
595 .Bd -literal -offset indent
596 NO_PROXY=localhost,127.0.0.1
606 .%B File Transfer Protocol
614 .%T How to Use Anonymous FTP
622 .%T Uniform Resource Locators (URL)
634 .%B Hypertext Transfer Protocol -- HTTP/1.1
646 .%B HTTP Authentication: Basic and Digest Access Authentication
652 library first appeared in
658 library was mostly written by
659 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
660 with numerous suggestions from
661 .An Jordan K. Hubbard Aq jkh@FreeBSD.org ,
662 .An Eugene Skepner Aq eu@qub.com
666 It replaces the older
669 .An Poul-Henning Kamp Aq phk@FreeBSD.org
671 .An Jordan K. Hubbard Aq jkh@FreeBSD.org .
673 This manual page was written by
674 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
676 Some parts of the library are not yet implemented.
682 and FTP proxy support.
684 There is no way to select a proxy at run-time other than setting the
688 environment variables as appropriate.
691 does not understand or obey 305 (Use Proxy) replies.
693 Error numbers are unique only within a certain context; the error
694 codes used for FTP and HTTP overlap, as do those used for resolver and
696 For instance, error code 202 means "Command not
697 implemented, superfluous at this site" in an FTP context and
698 "Accepted" in an HTTP context.
701 does not check that the result of an MDTM command is a valid date.
703 The man page is incomplete, poorly written and produces badly
706 The error reporting mechanism is unsatisfactory.
708 Some parts of the code are not fully reentrant.