Globus GridFTP Server Manual Page

Show usage information and exit.

Show more usage information and exit.

Show version information for the server and exit.

Show version information for all loaded globus libraries and exit.

Run under an inetd service.

Run as a daemon. All connections will fork off a new process and setuid if allowed.

Run as a background daemon detached from any controlling terminals.

Run over a connected ssh session.

For statically compiled or non-GLOBUS_LOCATION standard binary locations, specify the full path of the server binary here. Only needed when run in daemon mode.

Change directory when the server starts. This will change directory to the dir specified by the chdir_to option.

Directory to chdir to after starting. Will use / if not set. Note that this is the directory of the process, not the client’s home directory.

Enable threaded operation and set the number of threads. The default is 0, which is non-threaded. When threading is required, a thread count of 1 or 2 should be sufficient.

Server will fork for each new connection. Disabling this option is only recommended when debugging. Note that non-forked servers running as 'root' will only accept a single connection, and then exit.

Exit after a single connection.

Path to become the new root after authentication. This path must contain a valid certificate structure, /etc/passwd, and /etc/group. The command globus-gridftp-server-setup-chroot can help create a suitable directory structure.

Add levels together to use more than one. 0 = Disables all authorization checks. 1 = Authorize identity. 2 = Authorize all file/resource accesses. 4 = Disable changing process uid to authenticated user (no setuid) — DO NOT use this when process is started as root. If not set uses level 2 for front ends and level 1 for data nodes. Note that levels 2 and 4 imply level 1 as well.

User to setuid to upon login for all connections. Only applies when running as root.

Group to setgid to upon login for all connections. If unset, the default group of process_user will be used.

Only allow connections from these source ip addresses. Specify a comma separated list of ip address fragments. A match is any ip address that starts with the specified fragment. Example: '192.168.1.' will match and allow a connection from 192.168.1.45. Note that if this option is used any address not specifically allowed will be denied.

Deny connections from these source ip addresses. Specify a comma separated list of ip address fragments. A match is any ip address that starts with the specified fragment. Example: '192.168.2.' will match and deny a connection from 192.168.2.45.

Only allow connections from these source ip addresses. Specify a comma separated list of ip address fragments. A match is any ip address that starts with the specified fragment. Example: '192.168.1.' will match and allow a connection from 192.168.1.45. Note that if this option is used any address not specifically allowed will be denied.

Deny connections from these source ip addresses. Specify a comma separated list of ip address fragments. A match is any ip address that starts with the specified fragment. Example: '192.168.2.' will match and deny a connection from 192.168.2.45.

Require encrypted data channels. This will cause an error and prevent all transfers in which the client does not request an authenticated and encrypted data channel.

Use GSI security on ipc channel.

Set GSI authorization mode for the ipc connection. Options are: none, host, self or subject:[subject].

Allow clear text anonymous access. If server is running as root anonymous_user must also be set. Disables ipc security.

Comma separated list of names to treat as anonymous users when allowing anonymous access. If not set, the default names of 'anonymous' and 'ftp' will be allowed. Use '*' to allow any username.

User to setuid to for an anonymous connection. Only applies when running as root.

Group to setgid to for an anonymous connection. If unset, the default group of anonymous_user will be used.

Allow sharing when using the supplied DN. A client connected with these credentials will be able to access any user for which sharing is enabled.

Full path to a directory that will contain files used by GridFTP to control sharing access for individual local accounts. The special variables '$HOME' and '$USER' can be used to create a dynamic path that is unique to each local account. This pathmust be writable by the associated account. The default path is '$HOME/.globus/sharing/'. This must refer to a path on the filesystem, not a path that is only accessible via a DSI plugin.

Allow a local user account to control its own sharing access via special GridFTP client commands. The user account must have filesystem write access to the sharing state dir.

Sharing specific path restrictions. This completely replaces the normal path restrictions (-rp) when an account is being shared by a sharing-dn login.Follows normal path restriction semantics.

Comma separated list of usernames that are allowed to share unless matched in the user deny lists. If this list is set, users that are not included will be denied unless matched in the group allow list.

Comma separated list of usernames that are denied sharing even if matched in the user or group allow lists.

Comma separated list of groups whose members are allowed to share unless matched in the user or group deny lists. If this list is set, groups that are not included will be denied unless matched in the user allow list.

Comma separated list of groups whose members will be denied sharing unless matched in the user allow list.

Allow clients to be mapped to the root account.

Do not check if a user’s system account is disabled before allowing login.

Enable clear text access and authenticate users against this /etc/passwd formatted file.

Maximum concurrent connections allowed. Only applies when running in daemon mode. Unlimited if not set.

Disable all new connections. For daemon mode, issue a SIGHUP to the server process after changing the config file in order to not affect ongoing connections.

Custom message to be displayed to clients when the server is offline via the connections_disabled or connections_max = 0 options.

A comma separated list of client commands that will be disabled.

Enable the GSI authorization callout framework, for callouts such as CAS.

Set the starting directory to the authenticated users home dir. Disabling this is the same as setting '-home-dir /'.

Set a path to override the system defined home/starting directory for authenticated users. The special variable strings '$USER' and '$HOME' may be used. The authenticated username will be substituted for $USER, and the user’s real home dir will be substituted for $HOME. Be sure to escape the $ character if using these on the command line.

A comma separated list of full paths that clients may access. Each path may be prefixed by R and/or W, denoting read or write access, otherwise full access is granted. If a given path is a directory, all contents and subdirectories will be given the same access. Order of paths does not matter — the permissions on the longest matching path will apply. The special character '\~' will be replaced by the authenticated user’s home directory, or the '-home-dir' option, if used. Note that if the home directory is not accessible, '\~' will be set to '/'. By default all paths are allowed, and access control is handled by the OS. In a striped or split process configuration, this should be set on both the frontend and data nodes.

Do not verify that a symlink points to an allowed path before following. By default, symlinks are followed only when they point to an allowed path. By enabling this option, symlinks will be followed even if they point to a path that is otherwise restricted.

A comma separated list of ACL or event modules to load.

Log level. A comma separated list of levels from: 'ERROR, WARN, INFO, TRANSFER, DUMP, ALL'. TRANSFER includes the same statistics that are sent to the separate transfer log when -log-transfer is used. Example: error,warn,info. You may also specify a numeric level of 1-255. The default level is ERROR.

globus_logging module that will be loaded. If not set, the default 'stdio' module will be used, and the logfile options apply. Built in modules are 'stdio' and 'syslog'. Log module options may be set by specifying module:opt1=val1:opt2=val2. Available options for the built in modules are 'interval' and 'buffer', for buffer flush interval and buffer size, respectively. The default options are a 64k buffer size and a 5 second flush interval. A 0 second flush interval will disable periodic flushing, and the buffer will only flush when it is full. A value of 0 for buffer will disable buffering and all messages will be written immediately. Example: -log-module stdio:buffer=4096:interval=10

Path of a single file to log all activity to. If neither this option or log_unique is set, logs will be written to stderr unless the execution mode is detached or inetd, in which case logging will be disabled.

Partial path to which 'gridftp.(pid).log' will be appended to construct the log filename. Example: -L /var/log/gridftp/ will create a separate log ( /var/log/gridftp/gridftp.xxxx.log ) for each process (which is normally each new client session). If neither this option or log_single is set, logs will be written to stderr unless the execution mode is detached or inetd, in which case logging will be disabled.

Log netlogger style info for each transfer into this file. You may also use the log-level of TRANSFER to include this info in the standard log.

File access permissions of log files. Should be an octal number such as 0644.

Disable transmission of per-transfer usage statistics. See the Usage Statistics section in the online documentation for more information.

Comma separated list of contact strings (host:port) for usage statistics receivers. The usage stats sent to a particular receiver may be customized by configuring it with a taglist (host:port!taglist) The taglist is a list of characters that each correspond to a usage stats tag. When this option is unset, stats are reported to usage-stats.globus.org:4810. If you set your own receiver, and wish to continue reporting to the Globus receiver, you will need to add it manually. The list of available tags follow. Tags marked * are reported by default.

*(e) START - start time of transfer
*(E) END - end time of transfer
*(v) VER - version string of GridFTP server
*(b) BUFFER - tcp buffer size used for transfer
*(B) BLOCK - disk blocksize used for transfer
*(N) NBYTES - number of bytes transferred
*(s) STREAMS - number of parallel streams used
*(S) STRIPES - number of stripes used
*(t) TYPE - transfer command: RETR, STOR, LIST, etc
*(c) CODE - ftp result code (226 = success, 5xx = fail)
*(D) DSI - DSI module in use
*(A) EM - event modules in use
*(T) SCHEME - ftp, gsiftp, sshftp, etc. (client supplied)
*(a) APP - guc, rft, generic library app, etc. (client supplied)
*(V) APPVER - version string of above. (client supplied)
(f) FILE - name of file/data transferred
(i) CLIENTIP - ip address of host running client (control channel)
(I) DATAIP - ip address of source/dest host of data (data channel)
(u) USER - local user name the transfer was performed as
(d) USERDN - DN that was mapped to user id
(C) CONFID - ID defined by -usage-stats-id config option
(U) SESSID - unique id that can be used to match transfers in a session and
    transfers across source/dest of a third party transfer. (client supplied)

Identifying tag to include in usage statistics data. If this is set and usage-stats-target is unset, CONFID will be added to the default usage stats data.

Comma separated list of remote node contact strings.

When a server is configured for striped operation with the 'remote_nodes' option, both a frontend and backend process are started even if the client does not request multiple stripes. This option will start backend processes only when striped operation is requested by the client, while servicing non-striped requests with a single frontend process.

This server is a backend data node.

Size in bytes of sequential data that each stripe will transfer.

Number of number stripes to use per transfer when this server controls that number. If remote nodes are statically configured (via -r or remote_nodes), this will be set to that number of nodes, otherwise the default is 1.

Stripe layout. 1 = Partitioned 2 = Blocked.

Do not allow client to override stripe blocksize with the OPTS RETR command

Do not allow client to override stripe layout with the OPTS RETR command

Size in bytes of data blocks to read from disk before posting to the network.

Flush disk writes before sending a restart marker. This attempts to ensure that the range specified in the restart marker has actually been committed to disk. This option will probably impact performance, and may result in different behavior on different storage systems. See the manpage for sync() for more information.

Set the default permissions for created files. Should be an octal number such as 0644. The default is 0644. Note: If umask is set it will affect this setting — i.e. if the umask is 0002 and this setting is 0666, the resulting files will be created with permissions of 0664.

Timeout in seconds for all disk accesses. A value of 0 disables the timeout.

Port on which a frontend will listen for client control channel connections, or on which a data node will listen for connections from a frontend. If not set a random port will be chosen and printed via the logging mechanism.

Hostname or IP address of the interface to listen for control connections on. If not set will listen on all interfaces.

Hostname or IP address of the interface to use for data connections. If not set will use the current control interface.

Hostname or IP address of the interface to use for ipc connections. If not set will listen on all interfaces.

Effectively sets the above control_interface, data_interface and ipc_interface options.

Port on which the frontend will listen for data node connections.

Time in seconds to allow a client to remain connected to the control channel without activity before authenticating.

Time in seconds to allow a client to remain connected to the control channel without activity.

Idle time in seconds before an unused ipc connection will close.

Time in seconds before canceling an attempted ipc connection.

Enable protocol support for UDT with NAT traversal if the udt driver is available. Requires threads.

Port range to use for incoming connections. The format is "startport,endport". This, along with -data-interface, can be used to enable operation behind a firewall and/or when NAT is involved. This is the same as setting the environment variable GLOBUS_TCP_PORT_RANGE.

Message to display to the client before authentication.

File to read banner message from.

When this is set, the minimum allowed banner message will be displayed to unauthenticated clients.

When this is set, the message set in the 'banner' or 'banner_file' option will be appended to the default banner message rather than replacing it.

Add an identifying string to the existing toolkit version. This is displayed in the default banner message, the SITE VERSION command, and usage stats.

Message to display to the client after authentication.

File to read login message from.

Data Storage Interface module to load. File and remote modules are defined by the server. If not set, the file module is loaded, unless the 'remote' option is specified, in which case the remote module is loaded. An additional configuration string can be passed to the DSI using the format [module name]:[configuration string] to this option. The format of the configuration string is defined by the DSI being loaded.

Comma separated list of ERET/ESTO modules to allow, and optionally specify an alias for. Example: module1,alias2:module2,module3 (module2 will be loaded when a client asks for alias2).

A comma separated list of drivers allowed on the network stack.

A comma separated list of drivers allowed on the disk stack.

A comma separated list of programs that the popen driver is allowed to execute, when used on the network or disk stack. An alias may also be specified, so that a client does not need to specify the full path. Format is [alias:]prog,[alias:]prog. example: /bin/gzip,tar:/bin/tar

An option string to pass to the XIO Network Manager Driver, which will then be loaded for all data channel connections. This must be in the form "manager=module;option1=value;option2=value;". See the Network Manager documentation for more info.

A comma separated list of XIO drivers and options representing the default network stack. Format is of each driver entry is driver1[:opt1=val1;opt2=val2;…​]. The bottom of the stack, the transport driver, is always first.

A comma separated list of XIO drivers and options representing the default disk stack. Format is of each driver entry is driver1[:opt1=val1;opt2=val2;…​]. The bottom of the stack, the transport driver, is always first.

Path to main configuration file that should be loaded. Otherwise will attempt to load $GLOBUS_LOCATION/etc/gridftp.conf and /etc/grid-security/gridftp.conf.

Path to directory holding configuration files that should be loaded. Files will be loaded in alphabetical order, and in the event of duplicate parameters the last loaded file will take precedence. Files with a '.' in the name (file.bak, file.rpmsave, etc.) will be ignored. Note that the main configuration file, if one exists, will always be loaded last.

Base path to use when config and log path options are not full paths. By default this is the current directory when the process is started.

Sets options that make server easier to debug. Forces no-fork, no-chdir, and allows core dumps on bad signals instead of exiting cleanly. Not recommended for production servers. Note that non-forked servers running as 'root' will only accept a single connection, and then exit.

Write PID of the GridFTP server to this path. May contain variable references to ${localstatedir}