entrance_auth.h File Reference


Data Structures

struct  _Entrance_Auth
 Collection of data relating to authenticating off of the system. More...

Defines

#define AUTH_SUCCESS   0
#define E_SUCCESS   0
#define AUTH_FAIL   1
#define ERROR_NO_PAM_INIT   2
#define ERROR_BAD_PASS   3
#define ERROR_PAM_SET   4
#define ERROR_NO_PERMS   5
#define ERROR_CRED_EXPIRED   6
#define ERROR_BAD_CRED   7

Typedefs

typedef struct
_Entrance_Auth 
Entrance_Auth

Functions

Entrance_Authentrance_auth_new (void)
 entrance_auth_new
void entrance_auth_free (Entrance_Auth *e)
 entrance_auth_free the Entrance_Auth struct to be freed
void entrance_auth_session_end (Entrance_Auth *e)
 entrance_auth_session_end the Entrance_Auth handle for this session
void entrance_auth_clear_pass (Entrance_Auth *e)
 entrance_auth_clear_pass - Clear password from memory the Entrance_Auth handle for this session
int entrance_auth_cmp (Entrance_Auth *e, const char *display, int mode)
void entrance_auth_pass_set (Entrance_Auth *e, const char *str)
 entrance_auth_set_pass: keep the error checking here Pass it a char* and it'll set it if it should
int entrance_auth_user_set (Entrance_Auth *e, const char *str)
 set the username in the struct
void entrance_auth_setup_environment (Entrance_Auth *e, const char *display)
 entrance_auth_setup_environment - setup the users environment the Entrance_Auth to setup I'm not sure if this is correct, but for now it works.
void entrance_auth_reset (Entrance_Auth *e)
 entrance_auth_reset the Entrance_Auth struct to be reset

Detailed Description

Declares Entrance_Auth struct, and return value types

Define Documentation

#define AUTH_FAIL   1

#define AUTH_SUCCESS   0

#define E_SUCCESS   0

#define ERROR_BAD_CRED   7

#define ERROR_BAD_PASS   3

#define ERROR_CRED_EXPIRED   6

#define ERROR_NO_PAM_INIT   2

#define ERROR_NO_PERMS   5

#define ERROR_PAM_SET   4


Typedef Documentation

typedef struct _Entrance_Auth Entrance_Auth


Function Documentation

void entrance_auth_clear_pass ( Entrance_Auth e  ) 

entrance_auth_clear_pass - Clear password from memory the Entrance_Auth handle for this session

int entrance_auth_cmp ( Entrance_Auth e,
const char *  display,
int  mode 
)

void entrance_auth_free ( Entrance_Auth e  ) 

entrance_auth_free the Entrance_Auth struct to be freed

Entrance_Auth* entrance_auth_new ( void   ) 

entrance_auth_new

Returns:
a 0'd out Entrance_Auth Struct

void entrance_auth_pass_set ( Entrance_Auth e,
const char *  str 
)

entrance_auth_set_pass: keep the error checking here Pass it a char* and it'll set it if it should

void entrance_auth_reset ( Entrance_Auth e  ) 

entrance_auth_reset the Entrance_Auth struct to be reset

void entrance_auth_session_end ( Entrance_Auth e  ) 

entrance_auth_session_end the Entrance_Auth handle for this session

void entrance_auth_setup_environment ( Entrance_Auth e,
const char *  display 
)

entrance_auth_setup_environment - setup the users environment the Entrance_Auth to setup I'm not sure if this is correct, but for now it works.

int entrance_auth_user_set ( Entrance_Auth e,
const char *  str 
)

set the username in the struct

Parameters:
e - the Entrance_Auth to set the user of
str - a string to set the user to, NULL is fine
Returns:
0 on success, 1 on failure(User not in system) Check to see if the user exists on the system, if they do, e->user is set to the passed in string, if they don't, e->user is unmodified.