Module org.freedesktop.dbus

Package org.freedesktop.dbus.connections

Class SASL

java.lang.Object

org.freedesktop.dbus.connections.SASL

public class SASL
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SASL.Command
static enum	SASL.SaslCommand
static enum	SASL.SaslMode
static enum	SASL.SaslResult

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTH_ANON
static final int	AUTH_EXTERNAL
static final int	AUTH_NONE
static final int	AUTH_SHA
static final String	COOKIE_CONTEXT
static final int	COOKIE_TIMEOUT
static final int	EXPIRE_KEYS_TIMEOUT_SECONDS
static final int	LOCK_TIMEOUT
static final int	MAX_TIME_TRAVEL_SECONDS
static final int	NEW_KEY_TIMEOUT_SECONDS

Constructor Summary

Constructors

Constructor	Description
SASL()	Deprecated, for removal: This API element is subject to removal in a future version. should not be used as SASL configuration is not provided
SASL(SaslConfig _saslConfig)	Create a new SASL auth handler.

Method Summary

Modifier and Type	Method	Description
boolean	auth(SocketChannel _sock, AbstractTransport _transport)	Performs SASL auth on the given socketchannel.
String[]	convertAuthTypes(int _types)
boolean	isFileDescriptorSupported()
SASL.Command	receive(SocketChannel _sock)
void	send(SocketChannel _sock, SASL.SaslCommand _command, String... _data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AUTH_NONE

public static final int AUTH_NONE

See Also:

• Constant Field Values

AUTH_EXTERNAL

public static final int AUTH_EXTERNAL

See Also:

• Constant Field Values

AUTH_SHA

public static final int AUTH_SHA

See Also:

• Constant Field Values

AUTH_ANON

public static final int AUTH_ANON

See Also:

• Constant Field Values

LOCK_TIMEOUT

public static final int LOCK_TIMEOUT

See Also:

• Constant Field Values

NEW_KEY_TIMEOUT_SECONDS

public static final int NEW_KEY_TIMEOUT_SECONDS

See Also:

• Constant Field Values

EXPIRE_KEYS_TIMEOUT_SECONDS

public static final int EXPIRE_KEYS_TIMEOUT_SECONDS

See Also:

• Constant Field Values

MAX_TIME_TRAVEL_SECONDS

public static final int MAX_TIME_TRAVEL_SECONDS

See Also:

• Constant Field Values

COOKIE_TIMEOUT

public static final int COOKIE_TIMEOUT

See Also:

• Constant Field Values

COOKIE_CONTEXT

public static final String COOKIE_CONTEXT

See Also:

• Constant Field Values

Constructor Details

SASL

@Deprecated(since="4.2.2 - 2023-02-03",
            forRemoval=true)
public SASL()

Deprecated, for removal: This API element is subject to removal in a future version.

should not be used as SASL configuration is not provided

Create a new SASL auth handler. Defaults to disable file descriptor passing.

SASL

public SASL(SaslConfig _saslConfig)

Create a new SASL auth handler.

Parameters:

_hasFileDescriptorSupport - true to support file descriptor passing (usually only works with UNIX_SOCKET).

_saslConfig - SASL configuration

Method Details

receive

public SASL.Command receive(SocketChannel _sock)
                     throws IOException

Throws:

IOException

send

public void send(SocketChannel _sock,
 SASL.SaslCommand _command,
 String... _data)
          throws IOException

Throws:

IOException

convertAuthTypes

public String[] convertAuthTypes(int _types)

auth

public boolean auth(SocketChannel _sock,
 AbstractTransport _transport)
             throws IOException

Performs SASL auth on the given socketchannel. Mode selects whether to run as a SASL server or client. Types is a bitmask of the available auth types.

Parameters:

_config - sasl configuration parameters

_sock - socket channel

_transport - transport

Returns:

true if the auth was successful and false if it failed.

Throws:

IOException - on failure

isFileDescriptorSupported

public boolean isFileDescriptorSupported()