assh/assh_config.h header reference

Members  

Macros  

Members detail  

#define CONFIG_ASSH_ABI_WARN  

This macro is declared in assh/assh_config.h source file, line 0.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables warning at compile time for use of functions which are not ABI stable.

This macro expands to:

/**/

#define CONFIG_ASSH_AUTH_HOSTNAME_LEN 128  

This macro is declared in assh/assh_config.h source file, line 2.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum length of hostname for user authentication.

#define CONFIG_ASSH_AUTH_PASSWORD_LEN 32  

This macro is declared in assh/assh_config.h source file, line 3.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum length of password for user authentication.

#define CONFIG_ASSH_AUTH_USERNAME_LEN 32  

This macro is declared in assh/assh_config.h source file, line 4.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum length of username for user authentication.

#define CONFIG_ASSH_BIGNUM_WORD 64  

This macro is declared in assh/assh_config.h source file, line 6.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the word width used for bignum operations.

#define CONFIG_ASSH_BUILTIN_MD5  

This macro is declared in assh/assh_config.h source file, line 7.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables the MD5 message digest.

This macro expands to:

/**/

#define CONFIG_ASSH_BUILTIN_SHA1  

This macro is declared in assh/assh_config.h source file, line 8.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables the SHA1 message digest.

This macro expands to:

/**/

#define CONFIG_ASSH_BUILTIN_SHA2  

This macro is declared in assh/assh_config.h source file, line 9.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables the SHA2 message digest.

This macro expands to:

/**/

#define CONFIG_ASSH_BUILTIN_SHA3  

This macro is declared in assh/assh_config.h source file, line 10.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables the SHA3 message digest.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT  

This macro is declared in assh/assh_config.h source file, line 11.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the client side of the SSH protocol.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT_AUTH_HOSTBASED  

This macro is declared in assh/assh_config.h source file, line 12.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the host based user authentication method on client side.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT_AUTH_KEYBOARD  

This macro is declared in assh/assh_config.h source file, line 13.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the keyboard interactive user authentication method on client side.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT_AUTH_PASSWORD  

This macro is declared in assh/assh_config.h source file, line 14.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the password user authentication method on client side.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT_AUTH_PUBLICKEY  

This macro is declared in assh/assh_config.h source file, line 15.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the public key user authentication method on client side.

This macro expands to:

/**/

#define CONFIG_ASSH_CLIENT_AUTH_USE_PKOK  

This macro is declared in assh/assh_config.h source file, line 16.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables sending a public key lookup packet first instead of sending the signature directly during user authentication. The specification allows either behaviors.

This macro expands to:

/**/

#define CONFIG_ASSH_CRYPT_R 1  

This macro is declared in assh/assh_config.h source file, line 17.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables code that relies on the crypt_r function.

#define CONFIG_ASSH_GETPWNAM_R 1  

This macro is declared in assh/assh_config.h source file, line 18.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables code that relies on the getpwnam_r function.

#define CONFIG_ASSH_GETSPNAM_R 1  

This macro is declared in assh/assh_config.h source file, line 19.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables code that relies on the getspnam_r function.

#define CONFIG_ASSH_GNU_QSORTR 1  

This macro is declared in assh/assh_config.h source file, line 20.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables code which relies on the qsort_r function from the C library.

#define CONFIG_ASSH_IDENT_SIZE 255  

This macro is declared in assh/assh_config.h source file, line 21.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum length of the remote software identification string. rfc4253 section 4.2 requires 255 bytes which is almost never seen in practice. Using a lower value on embedded targets will reduce the size of the assh_session_s structure.

#define CONFIG_ASSH_KEY_CREATE  

This macro is declared in assh/assh_config.h source file, line 22.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for SSH key creation.

This macro expands to:

/**/

#define CONFIG_ASSH_KEY_VALIDATE  

This macro is declared in assh/assh_config.h source file, line 23.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for SSH key validation.

This macro expands to:

/**/

#define CONFIG_ASSH_MALLOC_USABLE_SIZE 1  

This macro is declared in assh/assh_config.h source file, line 24.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables code which relies on the malloc_usable_size function from the C library.

#define CONFIG_ASSH_MAX_PAYLOAD 32768  

This macro is declared in assh/assh_config.h source file, line 25.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum size of the ssh packet payload. rfc4253 section 6.1 requires at least 32768 bytes. Using a lower value on embedded targets will reduce the memory usage and limit resources exhaustion attacks.

#define CONFIG_ASSH_MAX_SERVICES 4  

This macro is declared in assh/assh_config.h source file, line 26.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum number of registered services.

#define CONFIG_ASSH_NO_REKEX_BEFORE_AUTH  

This macro is declared in assh/assh_config.h source file, line 27.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro disallows performing multiple key exchanges before user authentication. This is not required by the specification but helps preventing a simple resource exhaustion attacks.

This macro expands to:

/**/

#define CONFIG_ASSH_OPENSSH_PREFIX  

This macro is declared in assh/assh_config.h source file, line 28.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the path to OpenSSH host key files for use by helpers.

This macro expands to:

"/etc/ssh/"

#define CONFIG_ASSH_PACKET_POOL  

This macro is declared in assh/assh_config.h source file, line 29.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables the packet pool allocator.

This macro expands to:

/**/

#define CONFIG_ASSH_PACKET_POOL_SIZE 1048576  

This macro is declared in assh/assh_config.h source file, line 30.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the maximum byte amount of spare packets in the pool.

#define CONFIG_ASSH_SERVER  

This macro is declared in assh/assh_config.h source file, line 32.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the server side of the SSH protocol.

This macro expands to:

/**/

#define CONFIG_ASSH_SERVER_AUTH_HOSTBASED  

This macro is declared in assh/assh_config.h source file, line 33.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the host based user authentication method on server side.

This macro expands to:

/**/

#define CONFIG_ASSH_SERVER_AUTH_KEYBOARD  

This macro is declared in assh/assh_config.h source file, line 34.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the keyboard interactive user authentication method on server side.

This macro expands to:

/**/

#define CONFIG_ASSH_SERVER_AUTH_NONE  

This macro is declared in assh/assh_config.h source file, line 35.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the none user authentication method on server side.

This macro expands to:

/**/

#define CONFIG_ASSH_SERVER_AUTH_PASSWORD  

This macro is declared in assh/assh_config.h source file, line 36.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the password user authentication method on server side.

This macro expands to:

/**/

#define CONFIG_ASSH_SERVER_AUTH_PUBLICKEY  

This macro is declared in assh/assh_config.h source file, line 37.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for the public key user authentication method on server side.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_DEV_RANDOM  

This macro is declared in assh/assh_config.h source file, line 44.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables support for UNIX /dev/u?random random generator.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_GCRYPT  

This macro is declared in assh/assh_config.h source file, line 45.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of Libgcrypt.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_GCRYPT_ALLOC  

This macro is declared in assh/assh_config.h source file, line 46.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of the Libgcrypt secur memory allocator. This requires CONFIG_ASSH_USE_GCRYPT.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_GCRYPT_CIPHERS  

This macro is declared in assh/assh_config.h source file, line 47.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of Libgcrypt cipher algorithms. This requires CONFIG_ASSH_USE_GCRYPT.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_GCRYPT_PRNG  

This macro is declared in assh/assh_config.h source file, line 50.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of the Libgcrypt random number generator. This requires CONFIG_ASSH_USE_GCRYPT.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_OPENSSL  

This macro is declared in assh/assh_config.h source file, line 52.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro allows use of the OpenSSL library.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_OPENSSL_ALLOC  

This macro is declared in assh/assh_config.h source file, line 53.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of the OpenSSL secur memory allocator. This requires CONFIG_ASSH_USE_OPENSSL.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_OPENSSL_CIPHERS  

This macro is declared in assh/assh_config.h source file, line 54.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of the OpenSSL cipher algorithms. This requires CONFIG_ASSH_USE_OPENSSL.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_OPENSSL_PRNG  

This macro is declared in assh/assh_config.h source file, line 58.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables use of the OpenSSL random number generator. This requires CONFIG_ASSH_USE_OPENSSL.

This macro expands to:

/**/

#define CONFIG_ASSH_USE_ZLIB  

This macro is declared in assh/assh_config.h source file, line 64.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro allows use of the zlib library.

This macro expands to:

/**/

#define CONFIG_ASSH_VALGRIND  

This macro is declared in assh/assh_config.h source file, line 65.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro enables relying on valgrind headers files for better memory errors reporting.

This macro expands to:

/**/

#define CONFIG_ASSH_VERBOSE_ERROR  

This macro is declared in assh/assh_config.h source file, line 66.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

When defined, this macro embed error reasons strings in the library.

This macro expands to:

/**/

#define CONFIG_ASSH_ZLIB_ALLOC ASSH_ALLOC_INTERNAL  

This macro is declared in assh/assh_config.h source file, line 67.

Alternate declarations with same identifier: [1], [2].

Documentation from alternate declaration:

This macro specifies the allocator storage type used for the zlib context. The default is to use the ASSH_ALLOC_INTERNAL policy that does not allocate secur memory.

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Sep 27 13:33:19 2020 using MkDoc