# Cheatsheets

## ShiroAuthOptions

Shiro auth configuration options, see Vert.x Auth Shiro component and/or Apache Shiro project. note: this will be moved to vertx-auth project after 3.1

Name | Type | Description
`config` | `Json object` | Set the Shiro auth config.
`type` | `ShiroAuthRealmType` | Set the Shiro auth options type.

## AuthOptions

A common base object for authentication options. note: this will be moved to vertx-auth project after 3.1

Name | Type | Description

## ShellServiceOptions

The configurations options for the shell service, the shell connectors can be configured with link and link.

Name | Type | Description
`sshOptions` | `SSHOptions` | Set the SSH options, if the option is null, SSH will not be started.
`telnetOptions` | `TelnetOptions` | Set the Telnet options, if the option is null, Telnet will not be started.
`welcomeMessage` | `String` | Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

## SSHOptions

The SSH shell configuration options.

Name | Type | Description
`host` | `String` | Set the host
`keyPairOptions` | `JksOptions` | Set the key pair options in jks format, aka Java keystore.
`pemKeyPairOptions` | `PemKeyCertOptions` | Set the key pair store options in pem format.
`pfxKeyPairOptions` | `PfxOptions` | Set the key pair options in pfx format.
`port` | `Number (int)` | Set the port
`shiroAuthOptions` | `ShiroAuthOptions` | Set the auth options as a Shiro auth.

## TelnetOptions

Telnet options configuration, extends link.

Name | Type | Description
`acceptBacklog` | `Number (int)` | -
`clientAuth` | `ClientAuth` | -
`clientAuthRequired` | `Boolean` | -
`crlPaths` | `Array of String` | -
`crlValues` | `Array of Buffer` | -
`enabledCipherSuites` | `Array of String` | -
`host` | `String` | -
`idleTimeout` | `Number (int)` | -
`keyStoreOptions` | `JksOptions` | -
`pemKeyCertOptions` | `PemKeyCertOptions` | -
`pemTrustOptions` | `PemTrustOptions` | -
`pfxKeyCertOptions` | `PfxOptions` | -
`pfxTrustOptions` | `PfxOptions` | -
`port` | `Number (int)` | -
`receiveBufferSize` | `Number (int)` | -
`reuseAddress` | `Boolean` | -
`sendBufferSize` | `Number (int)` | -
`soLinger` | `Number (int)` | -
`ssl` | `Boolean` | -
`tcpKeepAlive` | `Boolean` | -
`tcpNoDelay` | `Boolean` | -
`trafficClass` | `Number (int)` | -
`trustStoreOptions` | `JksOptions` | -
`usePooledBuffers` | `Boolean` | -