CommunityToolkit.Aspire.Hosting.Sftp

CommunityToolkit.Aspire.Hosting.Sftp

Overview

This Aspire integration is a wrapper for the atmoz SFTP server image.

Usage

The SFTP integration exposes a connection string with the format endpoint=sftp://<host>:<port>.

Example 1: Add SFTP container with users as an argument or environment variable

Define users in (1) command arguments or (2) SFTP_USERS environment variable (syntax: user:pass[:e][:uid[:gid[:dir1[,dir2]...]]], see below for examples)

Add :e behind password to mark it as encrypted. On Windows, use wsl mkpasswd -m sha-512 to generate encrypted passwords.

builder.AddSftp("sftp").WithArgs($"foo:pass:::uploads");

builder.AddSftp("sftp").WithEnvironment("SFTP_USERS", "foo:pass:::uploads");

builder.AddSftp("sftp").WithEnvironment("SFTP_USERS", "foo:$5$t9qxNlrcFqVBNnad$U27ZrjbKNjv4JkRWvi6MjX4x6KXNQGr8NTIySOcDgi4:e:::uploads");

Example 2: Add SFTP container with users in config file

Define users in file mounted as /etc/sftp/users.conf using the WithUsersFile() extension method.

builder.AddSftp("sftp").WithUsersFile("users.conf");

Example 3: Add SFTP container with own host key

This container will generate new SSH host keys at first run. To avoid that your users get a MITM warning when you recreate your container (and the host keys changes), you can mount your own host keys with the WithHostKeyFile() extension method.

builder.AddSftp("sftp").WithUsersFile("users.conf").WithHostKeyFile("ssh_host_ed25519_key", KeyType.Ed25519);

Example 4: Add SFTP container with user public key

Mount public keys in the user's .ssh/keys/ directory using the WithUserKeyFile() extension method. All keys are automatically appended to .ssh/authorized_keys (you can't mount this file directly, because OpenSSH requires limited file permissions). In this example, we do not provide any password, so the user foo can only login with the corresponding private key.

builder.AddSftp("sftp").WithArgs("foo::::uploads").WithUserKeyFile("foo", "id_rsa.pub", KeyType.Rsa);

builder.AddSftp("sftp").WithArgs("foo::::uploads").WithUserKeyFile("foo", "id_ed25519.pub", KeyType.Ed25519);