Particle Physics Group

Seminars

News

NAME

htcp, htrm, htls, htll, htmkdir - get, put, delete or list HTTP/HTTPS files or directories

SYNOPSIS

htcp [options] Source-URL[s] [Destination URL]

DESCRIPTION

htcp is a client to fetch files or directory listings from remote servers using HTTP or HTTPS, or to put or delete files or directories onto remote servers using HTTPS. htcp is similar to scp(1), but uses HTTP/HTTPS rather than ssh as its transfer protocol.

When talking to an HTTPS server, htcp can run "anonymously", with a standard X.509 user certificate and key, or with a GSI Proxy. This makes htcp very useful in Grid environments where many users have certificates and where jobs and users have access to GSI proxies.

URLs

htcp supports the file:, http: and https: URL schemes as sources and destinations. If no scheme is given, the URL scheme is assumed to be file: and relative to the current directory if not an absolute path.

If multiple sources are given, they will be used in turn and the destination must be a directory (directories are indicated by a trailing /) However, source and destination cannot both refer to remote servers.

OPTIONS

-v/--verbose

Turn on debugging information. Used once, this option will enable htcp's messages to stderr. Used twice, will also enable the underlying libcurl messages.

--delete

Instead of copying files, delete all the URLs given on the command line. Calling the program as htrm has the same effect.

--list

Instead of copying files, output lists of files located in the URL-directories given on the command line. Calling the program as htls has the same effect.

--long-list

Instead of copying files, output long listings of files located in the URL-directories given on the command line. If available, the size in bytes and modification time of each file is given. Calling the program as htll has the same effect.

--mkdir

Instead of copying files, attempt to create a directory on a remote server with HTTP PUT. The server must support the convention that PUT to a URL with a trailing slash means create a directory. No file body is sent. Calling the program as htmkdir has the same effect.

--anon

Do not attempt to use X.509 user certificates or GSI proxies to authenticate to the remote HTTPS server. This means you are "anonymous", but the server's identity may still be verified and the connection is still encrypted.

--cert <X.509 cert path> and --key <X.509 key path>

Path to the PEM-encoded X.509 or GSI Proxy user certificate and key to use for HTTPS connections, intead of "anonymous mode." If only one of --key or --cert is given, then that will be tried for both. If neither is given, then the following order of precedence is used: the file name held by the variable X509_USER_PROXY; the file /tmp/x509up_uID (with Unix UID equal to ID); the file names held by X509_USER_CERT / X509_USER_KEY; the files ~/.globus/usercert.pem and ~/.globus/userkey.pem (where ~/ is the home directory of the user.)

--capath <X.509 CA root certs directory or file>

Path to the PEM-encoded CA root certificates to use when verifying remote servers' host certificates in HTTPS connections. Ideally this should be a directory of hash.0 files as described in the OpenSSL verify(1) man page, but a file may be used instead. If --capath is not given, the value of the environment variable X509_CERT_DIR will be tried. If this is not valid, then /etc/grid-security/certificates will be used.

--no-verify

Do not use CA root certificates to verify remote servers' host certificates. This is useful for testing sites before their certificate is set up properly, but leaves you vulnerable to "man in the middle" attacks by hostile servers masquerading as your target.

FILES

/tmp/x509up_uID

Default GSI Proxy file for Unix UID equal to ID.

/etc/grid-security/certificates

Default location for trusted Certification Authority root certificates to use when checking server certificates.

/tmp/.ca-roots-XXXXXX

Prior to 7.9.8, the underlying curl library did not support the CA root certificates directory. If built with an old version of libcurl, htcp will concatenate the certificates in the CA roots directory into a unique temporary file and use that.

ENVIRONMENT

X509_CERT_DIR

Holds directory to search for Certification Authority root certificates when verifying server certificates. (Tried if --capath is not given on the command line.)

X509_USER_PROXY

Holds file name of a GSI Proxy to use as user certificate. (Tried if --cert or --key are not given on the command line.)

X509_USER_CERT and X509_USER_KEY

Holds file name of X.509 user certificate and key. (Tried if X509_USER_PROXY is not valid.)

EXIT CODES

0 is returned on complete success. A non-zero return value indicates an error.

TO DO

Recursive copying. Server-site wildcards. Parallel streams. Error recovery.

BUGS

Not enough beta testing (hint hint...)

AUTHOR

Andrew McNab <mcnab@hep.man.ac.uk>

htcp is part of GridSite: http://www.gridpp.ac.uk/gridsite/

SEE ALSO

scp (1) curl (1) wget (1) verify (1)

This HTML page was made with roffit.


Last modified Fri 28 November 2003 . View page history
Switch to HTTPS . Website Help . Print View . Built with GridSite 2.2.6

Top^