@zero-transfer/ftps

Explicit and implicit FTPS with full TLS profile support.

Install

npm install @zero-transfer/ftps

Overview

FTPS over explicit AUTH TLS or implicit TLS, with PEM/PFX/P12 certificate sources, encrypted passive data channels, certificate fingerprint pinning, SNI/servername controls, and TLS min/max version configuration.

Usage

import {
  createTransferClient,
  uploadFile,
  downloadFile,
  createFtpsProviderFactory,
} from "@zero-transfer/ftps";

Public surface

This package publishes a narrowed surface of 4 exports. These symbols are also available from @zero-transfer/sdk; the table below links into the full API reference:

| Symbol | Kind | Notes | | --------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ | | createFtpsProviderFactory | Function | See API reference. | | FtpsProviderOptions | Interface | See API reference. | | FtpsMode | Type | See API reference. | | FtpsDataProtection | Type | See API reference. |

Examples

| Example | What it shows | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | examples/ftps-client-certificate.ts | FTPS client-certificate (mutual TLS) example with certificate pinning. | | examples/ftps-directory-ops.ts | FTPS directory operations: list, stat, mkdir, rename, remove, rmdir. |

Documentation

• Scope page
• Top-level README
• Full API reference
• Capability matrix
• Examples

License

MIT © Tony Wiedman