Functions to connect and authenticate to an SMB server. More...

#include "bdsm/smb_defs.h"
#include "bdsm/smb_types.h"

Functions
smb_session *	smb_session_new ()
	Allocates a new Session object. More...

void	smb_session_destroy (smb_session *s)
	Close a session and deallocate its ressources. More...

int	smb_session_state (smb_session *s)
	Returns the current state of the session. More...

void	smb_session_set_creds (smb_session s, const char domain, const char login, const char password)
	Set the credentials for this session. More...

int	smb_session_connect (smb_session s, const char hostname, uint32_t ip, int transport)
	Establish a connection and negotiate a session protocol with a remote host. More...

int	smb_session_login (smb_session *s)
	Authenticate on the remote host with the provided credentials. More...

int	smb_session_is_guest (smb_session *s)
	Am i logged in as Guest ? More...

const char *	smb_session_server_name (smb_session *s)
	Returns the server name with the <XX> type. More...

int	smb_session_supports (smb_session *s, int what)
	Check if a feature is supported/has been negociated with the server. More...

Detailed Description

Functions to connect and authenticate to an SMB server.

Function Documentation

int smb_session_connect	(	smb_session *	s,
		const char *	hostname,
		uint32_t	ip,
		int	transport
	)

Establish a connection and negotiate a session protocol with a remote host.

You have to provide both the ip and the name. This is a constraint of Netbios, which requires you to know its name before he accepts to speak with you.

Parameters

s	A session object.
hostname	The ASCII netbios name, the name type will be coerced to <20> since libdsm is about reading files
ip	The ip of the machine to connect to (in network byte order)
transport	The type of transport used, it could be SMB_TRANSPORT_TCP or SMB_TRANSPORT_NBT (Netbios over TCP, ie legacy)

Returns: 0 in case of error, a value > 0 otherwise.

void smb_session_destroy ( smb_session * s )

Close a session and deallocate its ressources.

After destroying a session, all the smb_tid, smb_fid and smb_fd associated with this session becomes invalid.

Parameters

s	The session to destroy

int smb_session_is_guest ( smb_session * s )

Am i logged in as Guest ?

Parameters

s	The session object

Returns: 1 -> Logged in as guest 0 -> Logged in as regular user -1 -> Error (not logged in, invalid session, etc.)

int smb_session_login ( smb_session * s )

Authenticate on the remote host with the provided credentials.

Can be called if session state is SMB_STATE_DIALECT_OK. If successfull, session state transition to SMB_STATE_SESSION_OK Provides the credentials with smb_session_set_creds.

Parameters

s	The session object.

Returns: 0 in case of failure, > 0 in case of success. Success doesn't mean you are logged in with the user you requested. If guest are activated on the remote host, when login fails, you are logged in as 'Guest'. Failure might also indicate you didn't supplied all the credentials

smb_session* smb_session_new ( )

Allocates a new Session object.

To be able to perform actions on shares and file, you'll need to call smb_session_connect, then authenticate with smb_authenticate.

Returns: A new Session object.

const char* smb_session_server_name ( smb_session * s )

Returns the server name with the <XX> type.

Parameters

s	The session object

Returns: The server name or NULL. The memory is owned by the session object.

void smb_session_set_creds	(	smb_session *	s,
		const char *	domain,
		const char *	login,
		const char *	password
	)

Set the credentials for this session.

Any of the params except s can be NULL.

Parameters

s	The session object.
domain	Domain to authenticate on. Often it's the same as netbios host.
login	The user to login as.
password	the user's password.

int smb_session_state ( smb_session * s )

Returns the current state of the session.

See also: SMB_STATE_ERROR; SMB_STATE_NEW; SMB_STATE_SESSION_OK

int smb_session_supports	(	smb_session *	s,
		int	what
	)

Check if a feature is supported/has been negociated with the server.

Parameters

s	The session object
what	Which features to check ?

See also: smb_session_supports_what

Returns: 0 if the feature is not supported, something else otherwise