org.apache.sshd.sftp.SftpModuleProperties Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.sshd.sftp;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.time.Duration;
import org.apache.sshd.common.Property;
import org.apache.sshd.common.PropertyResolver;
import org.apache.sshd.common.SshConstants;
import org.apache.sshd.common.util.ValidateUtils;
import org.apache.sshd.common.util.buffer.Buffer;
import org.apache.sshd.common.util.io.IoUtils;
import org.apache.sshd.server.config.SshServerConfigFileReader;
import org.apache.sshd.sftp.client.SftpClient;
import org.apache.sshd.sftp.common.SftpHelper;
import org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper;
import org.apache.sshd.sftp.server.SftpSubsystem;
/**
* Configurable properties for sshd-sftp.
*
* @author Apache MINA SSHD Project
*/
public final class SftpModuleProperties {
/**
* Used to indicate the {@link Charset} (or its name) for decoding referenced files/folders names - extracted from
* the client session when 1st initialized.
*
* @see SftpClient#getNameDecodingCharset()
* @see SftpClient#setNameDecodingCharset(Charset)
*/
public static final Property NAME_DECODING_CHARSET
= Property.charset("sftp-name-decoding-charset", StandardCharsets.UTF_8);
/**
* Property that can be used on the {@link org.apache.sshd.common.FactoryManager} to control the internal timeout
* used by the client to open a channel.
*/
public static final Property SFTP_CHANNEL_OPEN_TIMEOUT
= Property.duration("sftp-channel-open-timeout", Duration.ofSeconds(15L));
/**
* The maximum size of the channel pool used by an {@link org.apache.sshd.sftp.client.fs.SftpFileSystem}; by default
* 8. The value must be > zero.
*
* @see org.apache.sshd.sftp.client.fs.SftpFileSystem
*/
public static final Property POOL_SIZE
= Property.integer("sftp-fs-pool-size", 8);
/**
* A timeout after which idle channels in the pool of an {@link org.apache.sshd.sftp.client.fs.SftpFileSystem} are
* removed from the pool and closed; by default 10 seconds. If set to zero, channels in the pool will not expire and
* will be closed only then the file system is closed, or if the server closes them.
*
* The duration should not be shorter than 1 millisecond. If it is, 1 millisecond will be assumed.
*
*
* @see org.apache.sshd.sftp.client.fs.SftpFileSystem
*/
public static final Property POOL_LIFE_TIME
= Property.duration("sftp-fs-pool-life-time", Duration.ofSeconds(10));
/**
* If >= 0, that many channels may be kept open in the channel pool of an
* {@link org.apache.sshd.sftp.client.fs.SftpFileSystem} even if they are idle; by default 1. If >=
* {@link #POOL_SIZE}, channels will not expire and will be closed only then the file system is closed, or if the
* server closes them.
*
* @see org.apache.sshd.sftp.client.fs.SftpFileSystem
*/
public static final Property POOL_CORE_SIZE
= Property.integer("sftp-fs-pool-core-size", 1);
/**
* See {@link org.apache.sshd.sftp.client.fs.SftpFileSystemProvider}.
*/
public static final Property READ_BUFFER_SIZE
= Property.integer("sftp-fs-read-buffer-size");
/**
* See {@link org.apache.sshd.sftp.client.fs.SftpFileSystemProvider}.
*/
public static final Property WRITE_BUFFER_SIZE
= Property.integer("sftp-fs-write-buffer-size");
/**
* See {@link org.apache.sshd.sftp.client.fs.SftpFileSystemProvider}.
*/
public static final Property CONNECT_TIME
= Property.duration("sftp-fs-connect-time", Duration.ofSeconds(15L));
/**
* See {@link org.apache.sshd.sftp.client.fs.SftpFileSystemProvider}.
*/
public static final Property AUTH_TIME
= Property.duration("sftp-fs-auth-time", Duration.ofSeconds(15L));
/**
* See {@link org.apache.sshd.sftp.client.fs.SftpFileSystemProvider}.
*/
public static final Property NAME_DECODER_CHARSET
= Property.charset("sftp-fs-name-decoder-charset", StandardCharsets.UTF_8);
/**
* Property used to avoid large buffers when
* {@link org.apache.sshd.sftp.client.impl.AbstractSftpClient#write(SftpClient.Handle, long, byte[], int, int)} is
* invoked with a large buffer size.
*/
public static final Property WRITE_CHUNK_SIZE
= Property.integer("sftp-client-write-chunk-size",
SshConstants.SSH_REQUIRED_PAYLOAD_PACKET_LENGTH_SUPPORT - Long.SIZE);
/**
* Internal allocate buffer size when copying data to/from the channel
*/
public static final Property COPY_BUF_SIZE
= Property.integer("sftp-channel-copy-buf-size", IoUtils.DEFAULT_COPY_SIZE);
/**
* Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses via
* {@link SftpHelper#indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean)} call, as indicated by
* SFTP v6 - section 9.4
*/
public static final Property APPEND_END_OF_LIST_INDICATOR
= Property.bool("sftp-append-eol-indicator", true);
/**
* Whether to automatically follow symbolic links when resolving paths
*/
public static final Property AUTO_FOLLOW_LINKS
= Property.bool("sftp-auto-follow-links", true);
/**
* Allows controlling reports of which client extensions are supported (and reported via "support" and
* "support2" server extensions) as a comma-separate list of names. Note: requires overriding the
* {@link AbstractSftpSubsystemHelper#executeExtendedCommand(Buffer, int, String)} command accordingly. If empty
* string is set then no server extensions are reported
*
* @see AbstractSftpSubsystemHelper#DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
*/
public static final Property CLIENT_EXTENSIONS
= Property.string("sftp-client-extensions");
/**
* Comma-separated list of which {@code OpenSSH} extensions are reported and what version is reported for each -
* format: {@code name=version}. If empty value set, then no such extensions are reported. Otherwise, the
* {@link AbstractSftpSubsystemHelper#DEFAULT_OPEN_SSH_EXTENSIONS} are used
*/
public static final Property OPENSSH_EXTENSIONS
= Property.string("sftp-openssh-extensions");
/**
* Comma separate list of {@code SSH_ACL_CAP_xxx} names - where name can be without the prefix. If not defined then
* {@link AbstractSftpSubsystemHelper#DEFAULT_ACL_SUPPORTED_MASK} is used
*/
public static final Property ACL_SUPPORTED_MASK
= Property.string("sftp-acl-supported-mask");
/**
* Property that can be used to set the reported NL value. If not set, then {@link IoUtils#EOL} is used
*/
public static final Property NEWLINE_VALUE
= Property.string("sftp-newline", IoUtils.EOL);
public static final int MIN_READDATA_PACKET_LENGTH = 32768;
/**
* Force the use of a max. packet length for {@link AbstractSftpSubsystemHelper#doRead(Buffer, int)} protection
* against malicious packets
*/
public static final Property MAX_READDATA_PACKET_LENGTH
= Property.validating(Property.integer("sftp-max-readdata-packet-length", 63 * 1024),
l -> ValidateUtils.checkTrue(l >= MIN_READDATA_PACKET_LENGTH, "Length is below min.: %d", l));
public static final int MIN_WRITEDATA_PACKET_LENGTH = 32768;
/**
* Force the use of a max. packet length for {@link AbstractSftpSubsystemHelper#doWrite(Buffer, int)} protection
* against malicious packets
*/
public static final Property MAX_WRITEDATA_PACKET_LENGTH
= Property.validating(Property.integer("sftp-max-writedata-packet-length", 256 * 1024),
l -> ValidateUtils.checkTrue(l >= MIN_WRITEDATA_PACKET_LENGTH, "Length is below min.: %d", l));
/**
* Properties key for the maximum of available open handles per session. By default we impose virtually no limit and
* rely on the O/S.
*/
public static final Property MAX_OPEN_HANDLES_PER_SESSION
= Property.integer("max-open-handles-per-session", Integer.MAX_VALUE - 1);
public static final int MIN_FILE_HANDLE_SIZE = Integer.BYTES; // ~uint32
public static final int DEFAULT_FILE_HANDLE_SIZE = MIN_FILE_HANDLE_SIZE;
public static final int MAX_FILE_HANDLE_SIZE = 64; // ~sha512
/**
* Size in bytes of the opaque handle value
*
* @see #DEFAULT_FILE_HANDLE_SIZE
*/
public static final Property FILE_HANDLE_SIZE
= Property.validating(Property.integer("sftp-handle-size", DEFAULT_FILE_HANDLE_SIZE),
fhs -> {
ValidateUtils.checkTrue(fhs >= MIN_FILE_HANDLE_SIZE, "File handle size too small: %d", fhs);
ValidateUtils.checkTrue(fhs <= MAX_FILE_HANDLE_SIZE, "File handle size too big: %d", fhs);
});
public static final int MIN_FILE_HANDLE_ROUNDS = 1;
public static final int DEFAULT_FILE_HANDLE_ROUNDS = MIN_FILE_HANDLE_SIZE;
public static final int MAX_FILE_HANDLE_ROUNDS = MAX_FILE_HANDLE_SIZE;
/**
* Max. rounds to attempt to create a unique file handle - if all handles already in use after these many rounds,
* then an exception is thrown
*
* @see SftpSubsystem#generateFileHandle(Path)
* @see #DEFAULT_FILE_HANDLE_ROUNDS
*/
public static final Property MAX_FILE_HANDLE_RAND_ROUNDS
= Property.validating(
Property.integer("sftp-handle-rand-max-rounds", DEFAULT_FILE_HANDLE_ROUNDS),
fhrr -> {
ValidateUtils.checkTrue(fhrr >= MIN_FILE_HANDLE_ROUNDS, "File handle rounds too small: %d", fhrr);
ValidateUtils.checkTrue(fhrr <= MAX_FILE_HANDLE_ROUNDS, "File handle rounds too big: %d", fhrr);
});
/**
* Maximum amount of data allocated for listing the contents of a directory in any single invocation of
* {@link SftpSubsystem#doReadDir(Buffer, int)}
*/
public static final Property MAX_READDIR_DATA_SIZE
= Property.integer("sftp-max-readdir-data-size", 16 * 1024);
/**
* Apparently some SFTP servers may return more data than requested in SFTP read requests. This is a violation of
* the SFTP protocol. If this flag is {@code true}, such excess data is ignored and a warning is logged. If the flag
* is {@code false} (the default), an exception is thrown. The flag can be set on an SSH session or on the
* {@link SftpClient#getClientChannel() client channel} of an {@link SftpClient}.
*/
public static final Property TOLERATE_EXCESS_DATA = Property.bool("sftp-tolerate-excess-data", false);
/**
* Force the use of a given sftp version
*/
public static final Property SFTP_VERSION
= SshServerConfigFileReader.SFTP_FORCED_VERSION_PROP;
private SftpModuleProperties() {
throw new UnsupportedOperationException("No instance");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy