Enhanced File Transfer Server 4. COM API Manual

Transcription

1 Enhanced File Transfer Server 4 COM API Manual

2

3 Table Of Contents Using the Enhanced File Transfer Server COM interface... 1 COM interface methods and properties... 5 Server Interface Methods Server interface...11 Connecting users with the COM interface...12 Syntax Stopping the service with the COM interface...12 Accessing the list of server sites with the COM interface...13 Finding the local IP address with the COM interface...13 Retrieving the local server time with the COM interface...14 Finding allowed IP masks with the COM interface...14 Finding prohibited IP masks with the COM interface...14 Adding an IP mask with the COM interface...15 Removing an IP mask with the COM interface...15 Server Interface Properties Server interface...17 Finding or setting the default IP access mode with the COM interface...18 Editing the server's connection message with the COM interface...18 Editing the server's log path with the COM interface...18 Editing the server log type with the COM interface...18 Rotating logs with the COM interface...19 Edit the file path for certificates with the COM interface...19 Editing the file path for private key files with the COM interface...20 Editing private key pass phrases with the COM interface...20 Editing the administrator port with the COM interface...20 Editing the server administrator IP address with the COM interface...20 Allowing remote administration with the COM interface...21 Requiring SSL for remote administration with the COM interface...21 Editing the mail server address with the COM interface...21 Editing the mail server port with the COM interface...21 Editing the user name with the COM interface...22 Editing the password with the COM interface...22 iii

4 GlobalSCAPE Enhanced File Transfer Server COM Manual Choosing the server's sender name with the COM interface...22 Choosing the from address in server with the COM interface...22 Choosing recipient names with the COM interface...23 Choosing recipient addresses with the COM interface...23 Applying changes to the server with the COM interface...23 Refreshing server settings...23 Multiple Sites Interface Methods Sites interface...25 Retrieving a site's COM interface by site number...25 Finding the number of sites...26 Retrieving a site's COM interface by site number...26 Adding a site with the COM interface...26 Adding an NT authenticated site with the COM interface...27 Adding an Active Directory authenticated site...28 Adding an ODBC authenticated site with the COM interface...29 Adding a local site with the COM interface...31 Single Site Interface Methods Site interface...33 Starting an individual site with the COM interface...34 Stopping an individual site with the COM interface...35 Deleting a site with the COM interface...35 Site Information...35 Retrieve the number of connected users with the COM interface Identifying the authentication manager for a site with the COM interface Retrieving a site's root folder with the COM interface Choosing a site's root folder with the COM interface Finding a site's IP address with the COM interface Setting a site's IP address with the COM interface Finding a site's IP address with the COM interface Setting a site's PORT with the COM interface Checking a site's download speed with the COM interface Checking a site's upload speed with the COM interface Retrieving the number of active downloads with the COM interface Retrieving the number of active uploads with the COM interface Retrieving the site start time with the COM interface Site FTP and SSL access...37 Verifying FTP access is enabled for a site with the COM interface Allowing FTP access to a site with the COM interface Verifying explicit SSL is enabled for a site with the COM interface Verifying implicit SSL is enabled for a site with the COM interface Allowing explicit SSL access to a site with the COM interface Allowing implicit SSL access to a site with the COM interface iv

5 Table Of Contents Verifying FTP access is enabled for a site with the COM interface Allowing SFTP access to a site with the COM interface Site Certificates and Keys...40 Verifying that client certificates are required with the COM interface Requiring user certificates with the COM interface Changing the certificate file path with the COM interface Finding the file path for certificates with the COM interface Finding the file path for private keys with the COM interface Changing the private key file path with the COM interface Retrieving private key pass phrases with the COM interface Changing a private key pass phrase with the COM interface Retrieving the path to trusted certificates with the COM interface Retrieving the path to pending certificates with the COM interface Retrieving a list of trusted certificates Retrieving information for a trusted certificate Retrieving a list of pending certificates Retrieving information for a pending certificate Retrieving a certificate's data string with the COM interface Saving a trusted certificate to a file with the COM interface Deleting a trusted certificate Deleting a pending certificate Adding a pending certificate to the trusted list Site Folders...44 Retrieving a list of folders with the COM interface Listing folder permissions with the COM interface Setting folder permissions with the COM interface Removing folder permissions with the COM interface Creating blank permissions with the COM interface Creating a physical folder with the COM interface Creating a virtual folder with the COM interface Deleting a folder with the COM interface Renaming a folder with the COM interface Site Permission Groups...47 Creating a permissions group with the COM interface Retrieving a list of permission groups with the COM interface Deleting a permission group with the COM interface Renaming a permission group with the COM interface Adding a user to a permission group with the COM interface Deleting a user from a permission group with the COM interface Retrieving a list of a user's permission groups with the COM interface Site Users and Settings Levels...48 Creating a user with the COM interface Retrieving a list of users with the COM interface Deleting a user with the COM interface Renaming a user with the COM interface Retrieving a list of user Settings Levels with the COM interface v

6 GlobalSCAPE Enhanced File Transfer Server COM Manual Retrieving a list of users in a Settings Level with the COM interface Creating a Settings Level with the COM interface Deleting a Settings Level with the COM interface Renaming a Settings Level with the COM interface Moving a user to a Settings Level Changing a user's password with the COM interface Retrieving a list of a Settings Level's settings with the COM interface Retrieving a user's settings with the COM interface Site Custom Commands...54 Retrieving a list of custom commands Retrieving a custom command's settings Creating a new custom command Deleting a custom command with the COM interface Site IP masks...54 Adding an IP mask to a site with the COM interface Removing an IP mask from a site with the COM interface Retrieving a list of allowed IP masks with the COM interface Retrieving a list of denied IP masks with the COM interface Single Site Interface Properties Site interface...57 Site Options...58 Blocking site-to-site FTP Blocking anti-time-out schemes Retrieving and modifying a list of banned file types Handling a site's exit message with the COM interface Handling the user limit message with the COM interface Checking if a site is started with the COM interface Retrieving a site's ID with the COM interface Retrieving a site's name with the COM interface User Options...61 Setting the Grant Full Permissions option with the COM interface Setting the Auto Create Home Folder option with the COM interface Connection Limits...62 Allowing a site maximum transfer speed with the COM interface Retrieving or setting maximum transfer speed with the COM interface Limiting concurrent connections to a site with the COM interface Retrieving or setting maximum concurrent connections with the COM interface Limiting users' connections to a site with the COM interface Retrieving or setting a site's user connection limit with the COM interface IP Addresses...64 Limiting connections to a site from the same IP address with the COM interface.. 64 Retrieving or setting maximum concurrent connections allowed from the same IP address with the COM interface Limiting consecutive invalid commands with the COM interface vi

7 Table Of Contents Retrieving or setting the maximum number of consecutive invalid commands allowed with the COM interface Banning connections from specific IP addresses with the COM interface Banning IP addresses permanently or temporarily with the COM interface Enabling a range of ports for PASV connections with the COM interface Determining the IP address for PASV connections with the COM interface Determining the low end of a PASV mode port range with the COM interface Setting IP addresses that have access to a site with the COM interface Determining the high end of a PASV mode port range with the COM interface Permission Interface Properties Permissions interface...71 Retrieving a folder name with the COM interface...71 Retrieving a client or permission group name with the COM interface...72 Granting uploading permission with the COM interface...72 Granting deleting permission with the COM interface...72 Granting renaming permission with the COM interface...73 Granting file appending permission with the COM interface...73 Granting downloading permission with the COM interface...73 Granting folder creation permission with the COM interface...74 Granting folder deletion permission with the COM interface...74 Granting permission to see a list of folder contents with the COM interface...75 Showing files in a folder that usually remain hidden with the COM interface...75 Showing read-only files with the COM interface...76 Showing or hiding folders with the COM interface...77 Client Settings Interface Methods Client settings interface...79 Checking if an account or Settings Level is enabled with the COM interface...80 Enabling a user account or Settings Level with the COM interface...81 User settings...82 Checking if the account home folder is the default root folder with the COM interface Setting the account home folder as the default root folder with the COM interface 82 Checking how users' log in messages are used Setting how users' log in messages are used Retrieving the log in messages for users Setting the log in messages for users Checking if users can have a home folder Allowing users to have a home folder with the COM interface Finding users' home folders Choosing the path to users' home folders Checking if users are restricted to a specific IP address Restricting users to a specific IP address vii

8 GlobalSCAPE Enhanced File Transfer Server COM Manual Finding users' home IP address Setting users' home IP address Retrieving a user's description Setting a user's description Checking Web Transfer Client access Setting Web Transfer Client access Allowed commands...89 Checking if a user may send the NOOP command with the COM interface Allowing users to send the NOOP command with the COM interface Checking if a user can send the XCRC command with the COM interface Allowing users to send the XCRC command with the COM interface Checking if users can change their passwords Allowing users to change their passwords with the COM interface Connection limits...92 Checking if a user can be timed out Enabling time outs for inactive connections Checking how long a connection can be inactive before it is closed Setting how long a connection can be inactive before being closed Checking if an account will be disabled after too many failed password attempts.. 94 Limiting failed password attempts Retrieving the maximum number of failed login attempts allowed per user Setting the number of failed log in attempts allowed Checking the number of failed password attempts Checking if the number of concurrent connections is limited for users Enabling a concurrent connection limit for users Checking the maximum concurrent connections allowed per user Setting the maximum concurrent connections allowed per user Checking if an account is allowed to make SSL connections Allowing users to make SSL connections with the COM interface Checking if an account is allowed to make plain FTP connections Allowing users to make FTP connections Checking if the number of concurrent connections is limited for IP addresses Enabling a concurrent connection limit for IP addresses Checking the number of concurrent connections allowed from the same IP Setting the maximum number of concurrent connections allowed from the same IP address Transfer limits Checking if a user has a transfer speed limit Enabling a transfer speed limit for users Checking the maximum allowed transfer speed Setting the maximum allowed transfer speed Checking if a user has a download size limit Enabling a user's download size limit Retrieving a user's download size limit Setting the maximum file size a user is permitted to download Checking if a user has a download per session limit viii

9 Table Of Contents Enabling a user's download per session limit Retrieving the number of downloads permitted to a user per session Setting the maximum number of downloads a user is permitted per session Checking if a user has an upload size limit Enabling a user's upload size limit Retrieving a user's upload size limit Setting the maximum file size a user is permitted to upload Checking if a user has an upload per session limit Enabling a user's upload per session limit Retrieving the number of uploads permitted to a user per session Setting the maximum number of uploads a user is permitted per session Disk quotas Checking if an account has a disk quota Enabling a home folder disk quota for users Checking the disk quota size Setting the disk quota size Checking how much disk space a user has used Command Settings Interface Methods Command settings interface Listing users allowed to use a custom command Listing users allowed to use a command with the COM interface Prohibiting users from using a custom command Command Settings Interface Properties Command settings interface Finding or changing the name of a custom command Finding or changing the name of a custom command Finding or changing the name of a custom command Enabling a custom command Defining custom command parameters Requiring parameters for custom commands Requiring a minimum number of parameters for custom commands Choosing a message for an invalid number of command parameters Redirecting command output to clients Redirecting command output to a log Enabling a time limit for a custom command Setting the time limit for a custom command Certificate Interface Properties Certificate Information interface Retrieving a certificate ID Retrieving a certificate description Retrieving a certificate's start date ix

10 GlobalSCAPE Enhanced File Transfer Server COM Manual Retrieving a certificate's expiration date Certificate Issuer Finding who issued a certificate Retrieving a certificate issuer's unit Retrieving a certificate issuer's organization Retrieving the issuer's common name on a certificate Finding the certificate issuer's country Certificate Subject Retrieving a certificate subject's information Retrieving a certificate subject's unit Retrieving a certificate subject's organization Finding the certificate subject's country Retrieving a certificate subject's common name Sample Scripts x

11 1 Using the Enhanced File Transfer Server COM interface You can interact with the GlobalSCAPE's Secure class products directly from your own custom applications using any COM enabled programming language such as Visual Basic (VB), Java, C++, with the development IDE of your choice. To create a new script file or program, you need to have some familiarity with programming concepts and, ideally, some experience with a COM enabled programming language. The COM interface consists of: The SFTPCOMInterface.CIServer Class Several Interfaces The Methods and Properties for these Interfaces Notes If you set up secure remote administration, you will not be able to use the COM interface from remote machines. If you experience problems using COM remotely, try running your script or program locally (on the same system that the server resides on). Due to the wide range of scripts that GlobalSCAPE Secure FTP Server is able to accommodate we are unable to offer technical support on individual scripts other than what is available in the help files and online Knowledge Base. If you are having trouble with your script, try to perform the desired action manually using the Administrator Interface. If you move or copy the SFTPCOMInterface.dll file, you will also need to move or copy the SSL.dll file to the same location to use the COM interface for any SSL connections or functions. If you are able to perform the desired actions, and in the desired sequence when using the Administrator Interface, then the problem is not with the Server. The next thing to do is to troubleshoot your script line by line. If you use the COM interface from a remote machine, your administrator password will be sent over in plain text over the network you are using. CIServer class 1

12 GlobalSCAPE Enhanced File Transfer Server COM Manual The SFTPCOMInterface.CIServer class is the only SFTPCOMServer class that user applications use directly. To start using the SFTP COM interface a user application should create the SFTPCOMInterface.CIServer class object, and then use its methods and properties. Example Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer") CIServer implements the ICIServer interface. Interfaces ICIServer interface Use the ICIServer interface to access and manage the server and its attributes ICISites Interface Use the ICISites interface to list all sites, to add sites, and to find individual sites on the server. It can be obtained by using the Sites method of the ICIServer interface. Example Set Sites = SFTPServer.Sites ICISite Interface Use the ICISite interface to manage individual sites on the server. It can be obtained by using the Item and SiteByID methods of the ICISites interface. Example Set Site = Sites.Item(0) IPermission Interface Use the IPermission interface to set and manage folder permissons. Use the ICISite::GetFolderPermissions method to get folder permissions. Example aperm = s.getfolderpermissions("\pub\") Use the ICISite::GetBlankPermission method to get blank folder permissions. Example Set p = s.getblankpermission("\pub\"), "Administrative") Note Once you have changed properties with IPermission you must call the ICISite::SetPermission method to apply your changes or create new folder permissions. ICIClientSettings Interface 2

13 Using the COM interface Use the ICIClientSettings interface to manage client user or client group settings. Use the ICISite::GetGroupSettings method to access the interface. Example Set gs = s.getgroupsettings(s_gr) or use the ICISite::GetUserSettings method. Example Set us = s.getusersettings(ausr(j)) Note When you call methods or change properties of the ICIClientSettings interface, you must call ICIServer's ApplyChanges method in order for the changes to take effect. ICICommandSettings Interface Use the ICICommandSettings interface to create or manage site custom commands. Use the ICISite::GetCommandSettings method to access the interface. Example Set cs = s.getcommandsettings(acommands(i)) Note When you make changes with the ICICommandSettings interface the changes take effect immediately. You do not need to explicitly apply the changes. ICICertInfo Interface Use the ICICertInfo interface to obtain information about certificates. Use the ICISite::GetTrustedCertificateInfo method or the ICISite::GetPendingCertificateInfo method to access the interface. Examples Set ci = s.gettrustedcertificateinfo(acerts(i)) Set ci = s.getpendingcertificateinfo(acerts(i)) Note All the properties of the ICICertInfo interface are read only. Related Topics Samples Overview 3

14

15 2 COM interface methods and properties This is a comprehensive list of methods and properties available for the COM interface for Server organized by API. ICIServer interface Methods Properties ICISite interface Methods Properties ICICommandSettings interface Methods Properties ICISites interface Methods IPermission interface Properties ICIClientSettings interface Methods ICICertInfo interface Properties ICIServer interface Methods Connect Close Sites GetLocalIP GetAllowedMasks GetDeniedMasks AddIPAccessRule RemoveIPAccessRule GetLocalTime 5

16 GlobalSCAPE Enhanced File Transfer Server COM Manual Properties IPAccessAllowedDefault ConnectMessage LogPath LogType LogRotation CertificateFilePath KeyFilePath PassPhrase AdminPort ListenIP AllowRemoteAdministration UseSSLForAdministration SMTPServer SMTPPort SMTPLogin SMTPPassword SMTPSenderName SMTPSenderAddr SMTPRecipientName SMTPRecipientAddr ApplyChanges RefreshSettings ICISites interface Methods Item Count SiteById Add AddNTLMSite AddADSite AddODBCSite AddLocalSite ICISite interface Methods GetConnectedCount GetKeyFilePath CreatePermissionGroup GetUserSettings Start SetKeyFilePath GetPermissionGroups Remove Stop GetPassPhrase RemovePermissionGroup GetCommands GetAuthManagerID SetPassPhrase RenamePermissionGroup GetCommandSettings GetRootFolder GetTrustedCertsPath AddUserToPermissionGroup CreateCommand 6

17 COM interface methods and properties SetRootFolder GetAwaitingCertsPath RemoveUserFromPermissionGroup RemoveCommand GetIP GetDownloadSpeed CreateUser GetTrustedCertificates SetIP GetUploadSpeed CreateUserEx GetTrustedCertificateInfo GetPort GetDownloadCount GetUsers GetPendingCertificates SetPort GetUploadCount RemoveUser GetPendingCertificateInfo GetFTPAccess GetStartTime RenameUser ExportTrustedCertificate SetFTPAccess GetFolderList GetSettingLevels ImportTrustedCertificate GetSSLAuth GetFolderPermissions GetSettingLevelUsers RemoveTrustedCertificate GetSSLImp SetPermission CreateSettingLevel RemovePendingCertificate SetSSLAuth RemovePermission RemoveSettingLevel AddCertificateToTrusted SetSSLImp GetBlankPermission RenameSettingLevel GetAllowedMasks GetCheckClientCert CreatePhysicalFolder MoveUserToSettingLevel GetDeniedMasks SetCheckClientCert CreateVirtualFolder GetPermissionGroupsOfUser AddIPAccessRule GetCertFilePath RemoveFolder ChangeUserPassword RemoveIPAccessRule SetCertFilePath RenameFolder GetSettngsLevelSettings Properties Name AssignFullPermissionsForHomeFolder DisconnectOnDos ID HasMaxSpeed DOSLimit IsStarted MaxTransferSpeed BanIPOnDos UserLimitMessage HasMaxUsers AutoBanIPsPermanently ExitMessage MaxConcurrentConnections EnablePortRange VFSFilter HasMaxConnectionsPerAccount PASVListenIP BlockAntiTimeOut MaxConnectionsPerUser PASVPortMin BlockSiteToSite HasMaxIPPerAccount PASVPortMax AutoCreateHomeFolder MaxConnectionsFromSameIP IPAccessAllowedDefault 7

18 GlobalSCAPE Enhanced File Transfer Server COM Manual IPermission interface Properties Folder DirCreate Client FileUpload FileDelete FileRename FileAppend DirDelete DirList DirShowHidden DirShowReadOnly DirShowInList FileDownload ICIClientSettings interface Methods GetEnableAccount GetTimeOut SetClearFTP SetHasUploadsPerSession SetEnableAccount SetTimeOut GetHasMaxIPs GetUploadsPerSession GetHomeDirlsRoot GetHasMaxSpeed SetHasMaxIPs SetUploadsPerSession SetHomeDirlsRoot SetHasMaxSpeed GetMaxIPs GetLoginMsg GetAllowNoop GetMaxSpeed SetMaxIPs SetLoginMsg SetAllowNoop SetMaxSpeed GetHasMaxDownloadSize GetLoginMsgString GetAllowXCRC GetHasMaxUsers SetHasMaxDownloadSize SetLoginMsgString SetAllowXCRC SetHasMaxUsers GetMaxDownloadSize GetHomeDir GetChangePwd GetMaxUsers SetMaxDownloadSize SetHomeDir SetChangePwd SetMaxUsers GetHasDownloadsPerSession GetHomeDirString GetHasPwdRetries GetMaxSpace SetHasDownloadsPerSession SetHomeDirString SetHasPwdRetries SetMaxSpace GetDownloadsPerSession GetHomeIP GetPwdRetries GetUsedSpace SetDownloadsPerSession SetHomeIP SetPwdRetries GetEnableDiskQuota GetHasMaxUploadSize GetHomeIPString GetIncorrectPasswordAttempts SetEnableDiskQuota SetHasMaxUploadSize SetHomeIPString GetEnableTimeOut GetSSL GetMaxUploadSize GetDescription 8

19 COM interface methods and properties SetEnableTimeOut SetSSL SetMaxUploadSize SetDescription GetClearFTP GetHasUploadsPerSession ICICommandSettings interface Methods GetUserPermissions RemoveUserPermission AddUserPermission Properties Name Description Executable IsEnabled Parameters RequireParams MinNumOfParams MinNumOfParamsMsg RedirectOutputToClient RedirectOutputToLog EnableProcessTimeOut ProcessTimeOut ICICertInfo interface Properties ID IssuerCountry SubjectCountry Description IssuerCName SubjectCName IssuerOneLine SubjectOneLine NotBefore IssuerUnit SubjectUnit NotAfter IssuerOrg SubjectOrg 9

20

21 Server interface 3 Server Interface Methods The ICIServer interface allows you to manage the server and access the server's attributes. Methods Connect Close Sites GetLocalIP GetAllowedMasks GetDeniedMasks AddIPAccessRule RemoveIPAccessRule GetLocalTime Properties IPAccessAllowedDefault ConnectMessage LogPath LogType LogRotation CertificateFilePath KeyFilePath PassPhrase AdminPort ListenIP AllowRemoteAdministration UseSSLForAdministration SMTPServer SMTPPort SMTPLogin SMTPPassword SMTPSenderName SMTPSenderAddr SMTPRecipientName SMTPRecipientAddr ApplyChanges RefreshSettings 11

22 GlobalSCAPE Enhanced File Transfer Server COM Manual Connecting users with the COM interface Use the ICIServer interface Connect method to connect to the local or remote server as the administrator Syntax HRESULT Connect([in] BSTR Host, [in] UINT nport, [in] BSTR Login, [in] BSTR Password); VB Example: Dim Server As CIServer 'assumes the SFTPCOMInterface Type Library is referenced by the VB IDE Dim Site As CISite 'instantiates the ISite interface Dim Sites As CISites 'instantiates the ISites interface txtserver = " " 'local IP address of server txtport = "1000" 'admin port txtusername = "Admin" 'admin username txtpassword = "mypass" 'admin password On Error Resume Next 'verify it could connect ok Server.Connect txtserver, txtport, txtusername, txtpassword 'now connect using supplied information If Err.Number <> 0 Then MsgBox "Error connecting to '" & txtserver & ":" & txtport & "' -- " & Err.Description & " [" & CStr(Err.Number) & "]", vbinformation, "Error" 'all this on one line! End If Set Sites = Server.Sites 'now retrieve the list of sites in the server Set Site = Sites.Item(0) 'Instantiate the first and only, site (note, this script assumes only one site present) 'continue rest of code... Stopping the service with the COM interface Use the ICIServer interface Close method to stop the Server Service. 12

23 Server Interface Methods HRESULT Close(); Accessing the list of server sites with the COM interface Use the ICIServer Interface Sites method to access the list of sites and open the ICISites interface. You can subsequently use the ICISites Item method to retrieve a pointer to a particular site. HRESULT Sites([out, retval] ICISites** prop); Example in VB: Dim Server As CIServer 'assumes the SFTPCOMInterface Type Library is referenced by the VB IDE Dim Site As CISite 'instantiates the ISite interface Dim Sites As CISites 'instantiates the ISites interface 'insert connection routines here 'no retrieve the list of sites and then set a pointer to the first one Set Sites = Server.Sites 'now retrieve the list of sites in the server Set Site = Sites.Item(0) 'continue rest of code... Related Topics Sites interface Site interface Finding the local IP address with the COM interface Use the ICIServer interface GetLocalIP method to find the local IP address. HRESULT GetLocalIP( [in] long nip, [out, retval] BSTR *prop); 13

24 GlobalSCAPE Enhanced File Transfer Server COM Manual Retrieving the local server time with the COM interface Use the ICIServer interface GetLocalTime method to retrieve the time of day on the server. HRESULT GetLocalTime([out, retval] BSTR *ptime); Finding allowed IP masks with the COM interface Use the ICIServer interface GetAllowedMasks method to retrieve a list of allowed IP masks for the server. HRESULT GetAllowedMasks([out, retval] VARIANT *amasks); Related topics Retrieving a list of denied IP masks for the server Adding an IP mask to the server Removing an IP mask from the server Adding an IP mask to a site Removing IP masks from a site Retrieving a list of allowed IP mask for a site Retrieving a list of denied IP masks for a site Finding prohibited IP masks with the COM interface Use the ICIServer interface GetDeniedMasks method to retrieve a list of all prohibited IP masks for the server. HRESULT GetDeniedMasks([out, retval] VARIANT *amasks); Related topics Retrieving a list of allowed IP masks for the server Adding an IP mask to the server Removing an IP mask from the server Adding an IP mask to a site Removing IP masks from a site Retrieving a list of allowed IP mask for a site 14

25 Server Interface Methods Retrieving a list of denied IP masks for a site Adding an IP mask with the COM interface Use the ICIServer interface AddIPAccessRule method to add an allowed or denied IP mask to the server. HRESULT AddIPAccessRule( [in] BSTR bstrmask, [in] VARIANT_BOOL ballow); Related topics Retrieving a list of allowed IP masks for the server Retrieving a list of denied IP masks for the server Removing an IP mask from the server Adding an IP mask to a site Removing IP masks from a site Retrieving a list of allowed IP mask for a site Retrieving a list of denied IP masks for a site Removing an IP mask with the COM interface Use the ICIServer interface RemoveIPAccessRule method to delete an allowed or denied IP mask. HRESULT RemoveIPAccessRule( [in] BSTR bstrmask, [in] VARIANT_BOOL ballow); Related topics Retrieving a list of allowed IP masks for the server Retrieving a list of denied IP masks for the server Adding an IP mask to the server Adding an IP mask to a site Removing IP masks from a site Retrieving a list of allowed IP mask for a site Retrieving a list of denied IP masks for a site 15

26

27 Server interface 4 Server Interface Properties The ICIServer interface allows you to manage the server and access the server's attributes. Methods Connect Close Sites GetLocalIP GetAllowedMasks GetDeniedMasks AddIPAccessRule RemoveIPAccessRule GetLocalTime Properties IPAccessAllowedDefault ConnectMessage LogPath LogType LogRotation CertificateFilePath KeyFilePath PassPhrase AdminPort ListenIP AllowRemoteAdministration UseSSLForAdministration SMTPServer SMTPPort SMTPLogin SMTPPassword SMTPSenderName SMTPSenderAddr SMTPRecipientName SMTPRecipientAddr ApplyChanges RefreshSettings 17

28 GlobalSCAPE Enhanced File Transfer Server COM Manual Finding or setting the default IP access mode with the COM interface Use the ICIServer interface IPAccessAllowedDefault property to find or set the default IP Access mode. TRUE = Allowed FALSE = Denied HRESULT IPAccessAllowedDefault([out, retval] VARIANT_BOOL *pval); HRESULT IPAccessAllowedDefault([in] VARIANT_BOOL newval); Editing the server's connection message with the COM interface Use the ICIServer interface ConnectMessage property to retrieve or set the connection message sent to clients when users connect to the server. HRESULT ConnectMessage([out, retval] BSTR *pval); HRESULT ConnectMessage([in] BSTR newval); Editing the server's log path with the COM interface Use the ICIServer interface LogPath property to retrieve or set the file path to the server's log. You must restart the server to complete any changes to the server's log path. HRESULT LogPath([out, retval] BSTR *pval); HRESULT LogPath([in] BSTR newval); Editing the server log type with the COM interface Use the ICIServer interface LogType property to retrieve or set the server's log format. You can choose no log, or you can choose to generate a log in one of three formats. Value Format 0 W3C 18

29 Server Interface Properties 1 IIS 2 NCSA 3 No logging HRESULT LogType([out, retval] int *pval); HRESULT LogType([in] int newval); Note You must restart the server for any changes to the log format to take effect. Rotating logs with the COM interface Use the ICIServer interface LogRotation property to retrieve or set the amount of time before a new log is started. You can choose no rotation, or three different lengths of time. Value Rotation period 0 Never 1 Daily 2 Weekly 3 Monthly HRESULT LogRotation([out, retval] int *pval); HRESULT LogRotation([in] int newval); Note You must restart the server to complete any change to the log rotation period. Edit the file path for certificates with the COM interface Use the ICIServer interface CertificateFilePath property to retrieve or modify the file path to the server's certificates. 19

30 GlobalSCAPE Enhanced File Transfer Server COM Manual HRESULT CertificateFilePath([out, retval] BSTR *pval); HRESULT CertificateFilePath([in] BSTR newval); Editing the file path for private key files with the COM interface Use the ICIServer interface KeyFilePath property to retrieve or modify the file path for the server's private key files. HRESULT KeyFilePath([out, retval] BSTR *pval); HRESULT KeyFilePath([in] BSTR newval); Editing private key pass phrases with the COM interface Use the ICIServer interface PassPhrase property to retrieve or modify any certificate private key pass phrases. HRESULT PassPhrase([out, retval] BSTR *pval); HRESULT PassPhrase([in] BSTR newval); Editing the administrator port with the COM interface Use the ICIServer interface AdminPort property to retrieve or modify the port used for connecting to administrated the server. HRESULT AdminPort([out, retval] long *pval); HRESULT AdminPort([in] long newval); Note You must restart the server to apply any change to the server administrator port. Editing the server administrator IP address with the COM interface Use the ICIServer interface ListenIP property to retrieve or modify the server administrator's IP address. HRESULT ListenIP([out, retval] long *pval); HRESULT ListenIP([in] long newval); 20

31 Server Interface Properties Allowing remote administration with the COM interface Use the ICIServer interface AllowRemoteAdministration property to allow or prohibit remote administration of the server. HRESULT AllowRemoteAdministration([out, retval] VARIANT_BOOL *pval); HRESULT AllowRemoteAdministration([in] VARIANT_BOOL newval); Requiring SSL for remote administration with the COM interface Use the ICIServer interface UseSSLForAdministration property to enable or disable secure administration of the server over an SSL connection. HRESULT UseSSLForAdministration([out, retval] VARIANT_BOOL *pval); HRESULT UseSSLForAdministration([in] VARIANT_BOOL newval); Note You must restart the server to apply changes made with the UseSSLForAdministration property. Editing the mail server address with the COM interface Use the ICIServer interface SMTPServer property to retrieve or modify the address for the server used by GlobalSCAPE Secure FTP Server for event notifications. HRESULT SMTPServer([out, retval] BSTR *pval); HRESULT SMTPServer([in] BSTR newval); Editing the mail server port with the COM interface Use the ICIServer interface SMTPPort property to retrieve or modify the port number for the server used by GlobalSCAPE Secure FTP Server for event notifications. HRESULT SMTPPort([out, retval] long *pval); 21

32 GlobalSCAPE Enhanced File Transfer Server COM Manual HRESULT SMTPPort([in] long newval); Editing the user name with the COM interface Use the ICIServer interface SMTPLogin property to retrieve or modify the user name for the server used by GlobalSCAPE Secure FTP Server for event notifications. HRESULT SMTPLogin([out, retval] BSTR *pval); HRESULT SMTPLogin([in] BSTR newval); Editing the password with the COM interface Use the ICIServer interface SMTPPassword property to retrieve or modify the password for the server used by GlobalSCAPE Secure FTP Server for event notifications. HRESULT SMTPPassword([out, retval] BSTR *pval); HRESULT SMTPPassword([in] BSTR newval); Choosing the server's sender name with the COM interface Use the ICIServer interface SMTPSenderName property to retrieve or modify the name used in notifications sent by GlobalSCAPE Secure FTP Server. HRESULT SMTPSenderName([out, retval] BSTR *pval); HRESULT SMTPSenderName([in] BSTR newval); Choosing the from address in server with the COM interface Use the ICIServer interface SMTPSenderAddr property to retrieve or modify the address in the From field of messages sent by GlobalSCAPE Secure FTP Server for event notifications. HRESULT SMTPSenderAddr([out, retval] BSTR *pval); HRESULT SMTPSenderAddr([in] BSTR newval); 22

33 Server Interface Properties Choosing recipient names with the COM interface Use the ICIServer interface SMTPRecipientName property to retrieve or modify the name of the recipient of notifications sent by GlobalSCAPE Secure FTP Server. HRESULT SMTPRecipientName([out, retval] BSTR *pval); HRESULT SMTPRecipientName([in] BSTR newval); Choosing recipient addresses with the COM interface Use the ICIServer interface SMTPRecipientAddr property to retrieve or modify the address of the recipient notifications sent by GlobalSCAPE Secure FTP Server. HRESULT SMTPRecipientAddr([out, retval] BSTR *pval); HRESULT SMTPRecipientAddr([in] BSTR newval); Applying changes to the server with the COM interface Use the ICIServer interface ApplyChanges property to confirm and set changes you have made to GlobalSCAPE Secure FTP Server. HRESULT ApplyChanges(); Refreshing server settings Use the ICIServer interface RefreshSettings property to reload all settings from the server. HRESULT RefreshSettings(); 23

34

35 Sites interface 5 Multiple Sites Interface Methods The ICISites interface represents the list of all sites of the server. Obtain it by using the Sites method of the ICIServer interface. Example Set Sites = SFTPServer.Sites ICISites interface Methods Item Count SiteById Add AddNTLMSite AddADSite AddODBCSite AddLocalSite Retrieving a site's COM interface by site number Use the ICISites interface Item method and an integer to retrieve the ICISite interface for a specific site. Item( [in] VARIANT* Index, [out, retval] ICISite** prop); Note The Index value must be between 0 and (Count-1). Example: Set Sites = Server.Sites 'Retrieve list of sites Set Site = Sites.Item(0) 'Instantiate the first one 25

36 GlobalSCAPE Enhanced File Transfer Server COM Manual Finding the number of sites Use the ICISites interface Count method to retrieve the number of sites you have in the server. HRESULT Count([out, retval] long* prop); Retrieving a site's COM interface by site number Use the ICISites interface SiteByID method to retrieve the ICISite interface. HRESULT SiteByID( [in] long ID, [out, retval] ICISite** prop); Adding a site with the COM interface Use the ICISites interface Add method to create a new site and retrieve the site's ICISite interface. HRESULT Add( [in] BSTR bstrname, [in] BSTR bstrrootfolder, [in] int namid, [in] BSTR bstramdb, [in] VARIANT_BOOL bencryptpasswords, [in] int nip, [in] UINT nport, [in] VARIANT_BOOL bcreatehomefolder, [in] VARIANT_BOOL bpermhomefolder, [in] VARIANT_BOOL bautostart, [out, retval] ICISite** prop); Parameters bstrname bstrrootfolder namid Definition New site name Site root folder Authentication manager identifier 26

37 Multiple Sites Interface Methods bstramdb bencryptpasswords nip nport bcreatehomefolder bpermhomefolder bautostart Authentication manager database TRUE if database should contain encrypted passwords Index of the site IP address Port number of the site TRUE means that a home folder for new site users should be created TRUE means that new site users should be granted full permissions in their home folders TRUE means that the site should start automatically Adding an NT authenticated site with the COM interface Use the ICISites interface AddNTLMSite method to add a site that requires NTLM authentication to the server, and retrieve the site's COM interface. HRESULT AddNTLMSite( [in] BSTR bstrname, [in] BSTR bstrrootfolder, [in] BSTR bstrdomainname, [in] BSTR bstrallowgroup, [in] int nip, [in] UINT nport, [in] VARIANT_BOOL bcreatehomefolder, [in] VARIANT_BOOL bpermhomefolder, 27

38 GlobalSCAPE Enhanced File Transfer Server COM Manual [in] VARIANT_BOOL bautostart, [out, retval] ICISite** prop); Parameters bstrname bstrrootfolder bstrdomainname bstrallowgroup nip nport bcreatehomefolder bpermhomefolder bautostart Definition New site name Site root folder NT domain name NT group name Index of the site IP address Port number of the site TRUE means that a home folder for new site users should be created TRUE means that new site users should be granted full permissions in their home folders TRUE means that the site should start automatically Adding an Active Directory authenticated site Use the ICISites interface AddADSite method to add a site that requires Active Directory authentication to the server, and retrieve the site's COM interface. HRESULT AddADSite( [in] BSTR bstrname, [in] BSTR bstrrootfolder, [in] BSTR bstrdomaincontext, [in] BSTR bstrallowgroup, [in] int nip, [in] UINT nport, 28

39 Multiple Sites Interface Methods [in] VARIANT_BOOL bcreatehomefolder, [in] VARIANT_BOOL bpermhomefolder, [in] VARIANT_BOOL bautostart, [out, retval] ICISite** prop); Parameters bstrname bstrrootfolder bstrdomainname bstrallowgroup nip nport bcreatehomefolder bpermhomefolder bautostart Definition New site name Site root folder Default domain context for Active Directory Group name Index of the site IP address Port number of the site TRUE means that a home folder for new site users should be created TRUE means that new site users should be granted full permissions in their home folders TRUE means that the site should start automatically Adding an ODBC authenticated site with the COM interface Use the ICISites interface AddODBCSite method to add a site that uses an ODBC database for user authentication to the GlobalSCAPE Secure FTP server, and retrieve the site's COM interface. 29

40 GlobalSCAPE Enhanced File Transfer Server COM Manual HRESULT AddODBCSite( [in] BSTR bstrname, [in] BSTR bstrrootfolder, [in] BSTR bstrdsn, [in] VARIANT_BOOL bencryptpasswords, [in] int nip, [in] UINT nport, [in] VARIANT_BOOL bcreatehomefolder, [in] VARIANT_BOOL bpermhomefolder, [in] VARIANT_BOOL bautostart, [out, retval] ICISite** prop); Parameters bstrname bstrrootfolder bstrdsn bencryptpasswords nip nport bcreatehomefolder bpermhomefolder bautostart Definition New site name Site root folder Database DSN TRUE if the database should contain encrypted passwords Index of the site IP address Port number of the site TRUE means that a home folder for new site users should be created TRUE means that new site users should be granted full permissions in their home folders TRUE means that the site should start automatically 30

41 Multiple Sites Interface Methods Adding a local site with the COM interface Use the ICISites interface AddLocalSite method to create a new unauthenticated site and retrieve the site's ICISite interface. HRESULT AddLocalSite( [in] BSTR bstrname, [in] BSTR bstrrootfolder, [in] BSTR bstrfilepath, [in] int nip, [in] UINT nport, [in] VARIANT_BOOL bcreatehomefolder, [in] VARIANT_BOOL bpermhomefolder, [in] VARIANT_BOOL bautostart, [out, retval] ICISite** prop); Parameters bstrname bstrrootfolder bstrfilepath nip nport bcreatehomefolder bpermhomefolder Definition New site name Site root folder Path to the file that will contain user data Index of the site IP address Port number of the site TRUE means that a home folder for new site users should be created TRUE means that new site users should be granted full permissions in their home folders 31

42 GlobalSCAPE Enhanced File Transfer Server COM Manual bautostart TRUE means that the site should start automatically 32

43 Site interface 6 Single Site Interface Methods The ICISite interface represents an FTP/HTTP site. Use this interface to manage individual sites and to access their attributes. It can be obtained by using the Item and SiteByID methods of the ICISites interface. Example Set Site = Sites.Item(0) Methods Properties Methods GetConnectedCount GetKeyFilePath CreatePermissionGroup GetUserSettings Start SetKeyFilePath GetPermissionGroups Remove Stop GetPassPhrase RemovePermissionGroup GetCommands GetAuthManagerID SetPassPhrase RenamePermissionGroup GetCommandSettings GetRootFolder GetTrustedCertsPath AddUserToPermissionGroup CreateCommand SetRootFolder GetAwaitingCertsPath RemoveUserFromPermissionGroup RemoveCommand GetIP GetDownloadSpeed CreateUser GetTrustedCertificates SetIP GetUploadSpeed CreateUserEx GetTrustedCertificateInfo GetPort GetDownloadCount GetUsers GetPendingCertificates SetPort GetUploadCount RemoveUser GetPendingCertificateInfo GetFTPAccess GetStartTime RenameUser ExportTrustedCertificate SetFTPAccess GetFolderList GetSettingLevels ImportTrustedCertificate GetSSLAuth GetFolderPermissions GetSettingLevelUsers RemoveTrustedCertificate 33

44 GlobalSCAPE Enhanced File Transfer Server COM Manual GetSSLImp SetPermission CreateSettingLevel RemovePendingCertificate SetSSLAuth RemovePermission RemoveSettingLevel AddCertificateToTrusted SetSSLImp GetBlankPermission RenameSettingLevel GetAllowedMasks GetCheckClientCert CreatePhysicalFolder MoveUserToSettingLevel GetDeniedMasks SetCheckClientCert CreateVirtualFolder GetPermissionGroupsOfUser AddIPAccessRule GetCertFilePath RemoveFolder ChangeUserPassword RemoveIPAccessRule SetCertFilePath RenameFolder GetSettngsLevelSettings Properties Name AssignFullPermissionsForHomeFolder DisconnectOnDos ID HasMaxSpeed DOSLimit IsStarted MaxTransferSpeed BanIPOnDos UserLimitMessage HasMaxUsers AutoBanIPsPermanently ExitMessage MaxConcurrentConnections EnablePortRange VFSFilter HasMaxConnectionsPerAccount PASVListenIP BlockAntiTimeOut MaxConnectionsPerUser PASVPortMin BlockSiteToSite HasMaxIPPerAccount PASVPortMax AutoCreateHomeFolder MaxConnectionsFromSameIP IPAccessAllowedDefault Starting an individual site with the COM interface Use the ICISite interface Start method to start an individual site (start listening for incoming connections). HRESULT Start(); 34

45 Single Site Interface Methods Stopping an individual site with the COM interface Use the ICISite interface Stop method to stop an individual site from listening for incoming connections. HRESULT Stop(); Deleting a site with the COM interface Use the ICISite interface Remove method to delete a site from the server. HRESULT Remove(); Site Information Retrieve the number of connected users with the COM interface Use the ICISite interface GetConnectedCount method to retrieve the number of users currently connected to a site. HRESULT GetConnectedCount([out, retval] long* prop); Identifying the authentication manager for a site with the COM interface Use the ICISite Interface GetAuthManagerID method to identify or retrieve the authentication manager ID of a site. The authentication manager ID is the type of authentication used (GS Auth, NT/AD, or ODBC). HRESULT GetAuthManagerID([out, retval] long *prop); Retrieving a site's root folder with the COM interface Use the ICISite interface GetRootFolder method to retrieve the root folder for an individual site. HRESULT GetRootFolder([out, retval] BSTR *prop); 35

46 GlobalSCAPE Enhanced File Transfer Server COM Manual Choosing a site's root folder with the COM interface Use the ICISite interface SetRootFolder method to designate the root folder for an individual site. If the site has to be restarted for the change to take effect, the SetRootFolder method will return TRUE. HRESULT SetRootFolder( [in] BSTR newval, [out, retval] VARIANT_BOOL *pneedrestart); Finding a site's IP address with the COM interface Use the ICISite interface GetIP method to retrieve the IP address where a site listens for incoming connections. HRESULT GetIP([out, retval] long *prop); Setting a site's IP address with the COM interface Use the ICISite interface SetIP method to set the IP address where a site listens for incoming connections. If the site must be restarted after changing IP address the SetIP method returns TRUE. HRESULT SetIP( [in] long newval, [out, retval] VARIANT_BOOL *pneedrestart); Finding a site's IP address with the COM interface Use the ICISite interface GetPort method to retrieve the port number a site uses for connections (default for FTP connections). HRESULT GetPORT([out, retval] UINT *prop); Setting a site's PORT with the COM interface Use the ICISite interface SetPort method to set the a site's default PORT (used for FTP connections). If the site must be restarted after changing the port the SetPort method returns TRUE. HRESULT SetPort( [in] UINT newval, 36