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
(package private) static enum	SASL.SaslAuthState
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
private static final String	AUTH_TYPE_ANONYMOUS
private static final String	AUTH_TYPE_DBUS_COOKIE_SHA1
private static final String	AUTH_TYPE_EXTERNAL
private static final Set<PosixFilePermission>	BAD_FILE_PERMISSIONS
private String	challenge
private static final Collator	COL
private String	cookie
static final String	COOKIE_CONTEXT
static final int	COOKIE_TIMEOUT
private static final File	DBUS_KEYRINGS_DIR
private static final String	DBUS_TEST_HOME_DIR
static final int	EXPIRE_KEYS_TIMEOUT_SECONDS
private boolean	fileDescriptorSupported	whether file descriptor passing is supported on the current connection.
private static final String	INVALID_CMD_ERR
static final int	LOCK_TIMEOUT
private final org.slf4j.Logger	logger
private static final int	MAX_READ_BYTES
static final int	MAX_TIME_TRAVEL_SECONDS
static final int	NEW_KEY_TIMEOUT_SECONDS
private static final Random	RANDOM
private final SaslConfig	saslConfig
private static final String	SYSPROP_USER_HOME

Constructor Summary

Constructors

Constructor	Description
SASL(SaslConfig _saslConfig)	Create a new SASL auth handler.

Method Summary

Modifier and Type	Method	Description
private void	addCookie(String _context, String _id, long _timestamp, String _cookie)
boolean	auth(SocketChannel _sock, AbstractTransport _transport)	Performs SASL auth on the given socketchannel.
String[]	convertAuthTypes(int _types)
(package private) SASL.SaslResult	doChallenge(int _auth, SASL.Command _c)
(package private) SASL.SaslResult	doResponse(int _auth, String _uid, String _kernelUid, SASL.Command _c)
private String	findCookie(String _context, String _id)
private byte	getNibble(char _c)
private long	getUserId()	Tries to get the UID (user ID) of the current JVM process.
private int	handleReject(int _available, String _luid, SocketChannel _sock)	Handle reject of authentication.
boolean	isFileDescriptorSupported()
SASL.Command	receive(SocketChannel _sock)
void	send(SocketChannel _sock, SASL.SaslCommand _command, String... _data)
private String	stupidlyDecode(String _data)
private String	stupidlyEncode(byte[] _data)
private String	stupidlyEncode(String _data)	Takes the string, encodes it as hex and then turns it into a string again.

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

AUTH_TYPE_EXTERNAL

private static final String AUTH_TYPE_EXTERNAL

See Also:

• Constant Field Values

AUTH_TYPE_DBUS_COOKIE_SHA1

private static final String AUTH_TYPE_DBUS_COOKIE_SHA1

See Also:

• Constant Field Values

AUTH_TYPE_ANONYMOUS

private static final String AUTH_TYPE_ANONYMOUS

See Also:

• Constant Field Values

INVALID_CMD_ERR

private static final String INVALID_CMD_ERR

See Also:

• Constant Field Values

MAX_READ_BYTES

private static final int MAX_READ_BYTES

See Also:

• Constant Field Values

RANDOM

private static final Random RANDOM

COL

private static final Collator COL

SYSPROP_USER_HOME

private static final String SYSPROP_USER_HOME

DBUS_TEST_HOME_DIR

private static final String DBUS_TEST_HOME_DIR

DBUS_KEYRINGS_DIR

private static final File DBUS_KEYRINGS_DIR

BAD_FILE_PERMISSIONS

private static final Set<PosixFilePermission> BAD_FILE_PERMISSIONS

challenge

private String challenge

cookie

private String cookie

logger

private final org.slf4j.Logger logger

fileDescriptorSupported

private boolean fileDescriptorSupported

whether file descriptor passing is supported on the current connection.

saslConfig

private final SaslConfig saslConfig

Constructor Details

SASL

public SASL(SaslConfig _saslConfig)

Create a new SASL auth handler.

Parameters:

_saslConfig - SASL configuration

Method Details

findCookie

private String findCookie(String _context,
 String _id)
                   throws IOException

Throws:

IOException

addCookie

private void addCookie(String _context,
 String _id,
 long _timestamp,
 String _cookie)
                throws IOException

Throws:

IOException

stupidlyEncode

private String stupidlyEncode(String _data)

Takes the string, encodes it as hex and then turns it into a string again. No, I don't know why either.

stupidlyEncode

private String stupidlyEncode(byte[] _data)

getNibble

private byte getNibble(char _c)

stupidlyDecode

private String stupidlyDecode(String _data)

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

doChallenge

SASL.SaslResult doChallenge(int _auth,
 SASL.Command _c)
                     throws IOException

Throws:

IOException

doResponse

SASL.SaslResult doResponse(int _auth,
 String _uid,
 String _kernelUid,
 SASL.Command _c)

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:

_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()

handleReject

private int handleReject(int _available,
 String _luid,
 SocketChannel _sock)
                  throws IOException

Handle reject of authentication.

Parameters:

_available -

_luid -

_sock - socketchannel

Returns:

current state or -1 if failed

Throws:

IOException - when sending fails

getUserId

private long getUserId()

Tries to get the UID (user ID) of the current JVM process. Will always return 0 on windows.

Returns:

long