Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ssh_sftpd (3erl)

Name

ssh_sftpd - Specifies the channel process to handle an SFTP subsystem.

Synopsis

Please see following description for synopsis

Description

ssh_sftpd(3)               Erlang Module Definition               ssh_sftpd(3)



NAME
       ssh_sftpd - Specifies the channel process to handle an SFTP subsystem.

DESCRIPTION
       Specifies a channel process to handle an SFTP subsystem.

EXPORTS
       subsystem_spec(Options) -> Spec

              Types:

                 Options =
                     [{cwd, string()} |
                      {file_handler, CbMod | {CbMod, FileState}} |
                      {max_files, integer()} |
                      {root, string()} |
                      {sftpd_vsn, integer()}]
                 Spec = {Name, {CbMod, Options}}
                 Name = string()
                 CbMod = atom()
                 FileState = term()

              Is to be used together with ssh:daemon/[1,2,3]

              The  Name  is  "sftp" and CbMod is the name of the Erlang module
              implementing  the   subsystem   using   the   ssh_server_channel
              (replaces ssh_daemon_channel) behaviour.

              Options:

                cwd:
                  Sets the initial current working directory for the server.

                file_handler:
                  Determines  which  module  to  call  for  accessing the file
                  server. The default value is ssh_sftpd_file, which uses  the
                  file  and  filelib  APIs  to  access  the  standard OTP file
                  server. This option can  be  used  to  plug  in  other  file
                  servers.

                max_files:
                  The  default  value is 0, which means that there is no upper
                  limit. If supplied, the number of filenames returned to  the
                  SFTP  client  per  READDIR request is limited to at most the
                  given value.

                root:
                  Sets the SFTP root directory. Then the user cannot  see  any
                  files  above  this root. If, for example, the root directory
                  is set to /tmp, then the user sees this directory as  /.  If
                  the user then writes cd /etc, the user moves to /tmp/etc.

                sftpd_vsn:
                  Sets  the  SFTP  version to use. Defaults to 5. Version 6 is
                  under development and limited.



Ericsson AB                        ssh 4.13                       ssh_sftpd(3)