pam_kmux_options.c File Reference

#include "common.h"
#include "pam_kmux_options.h"
#include "parse_pam_kmux_options.h"
#include <string.h>
#include "msg.h"
#include "hashify.h"
#include "helpers.h"
#include "backend.h"
#include "backend_firebird.h"
#include "backend_mysql.h"
#include "backend_pgsql.h"

Include dependency graph for pam_kmux_options.c:

This graph shows which files directly or indirectly include this file:

Functions
void	init_pamod_options (void)
	Initilize global module options struct.
void	free_pamod_options (void)
	Free dynamically allocated space from the global module options struct.
void	set_pamod_defaults (void)
	Set default for global module option struct.
modopt_t *	get_modopt (void)
	Get a modopt_t object.
modopts_t *	get_modopts (void)
	Get a modopt_t object container.
char *	getstr_option (const modopt_t *options)
	Return module-options-buffer.
void	log_options (const modopt_t *options)
	Logging options.
void	log_options_constainer (const modopts_t *options_container)
modopts_t *	mod_options (int argc, const char **argv)
void	free_modopt (modopt_t *options)
	Free allocated modopt_t space.
void	free_modopts (modopts_t *options_container)
	Free allocated modopts_t space.
Variables
pam_modopt_t	pamod_options

---

Detailed Description

In this file the functions related to pam_kmux-module-options-processing are implemented.

Author:

Julian Thome

Date:

2009-11-11

---

Function Documentation

void free_modopt

(

modopt_t *

options

)

Free allocated modopt_t space.

This function frees the previously allocated space.

Parameters:

options

Allocated space to this pointer will be freed.

Returns:

Nothing to return.

void free_modopts

(

modopts_t *

options_container

)

Free allocated modopts_t space.

This function frees the previously allocated space.

Parameters:

options_container

Allocated space to this pointer will be freed.

Returns:

Nothing to return.

void free_pamod_options

(

void

)

Free dynamically allocated space from the global module options struct.

This function frees all dynamically allocated space from the global pam_modopt_t structure.

Returns:

Nothing to return.

modopt_t* get_modopt

(

void

)

Get a modopt_t object.

This function creates and initialize an modopt_t object and returns the memory adress.

Returns:

modopt_t Memory Adress to allocated and initialized struct.

modopts_t* get_modopts

(

void

)

Get a modopt_t object container.

This function creates and initialize an modopts_t object returns the memory adress.

Returns:

modopts_t Memory Adress to allocated and initialized struct.

char* getstr_option

(

const modopt_t *

options

)

Return module-options-buffer.

This function set default values for global pam_modopt_t structure to initialize it properly.

Return values:

	char*	Generated buffer which contains the whole module parameters. This buffer can be used for output.
	NULL	if something went wrong during buffer generation.

void init_pamod_options

(

void

)

Initilize global module options struct.

This function initialize the global struct which contains global module information.

Returns:

Nothing to return

void log_options

(

const modopt_t *

options

)

Logging options.

Log the complete options of the struct options, which represents a database-connection to syslog.

Parameters:

options

All informations of this parameter will be logged.

Returns:

Nothin to return.

void log_options_constainer

(

const modopts_t *

options_container

)

modopts_t* mod_options	(	int	argc,
		const char **	argv
	)

get a new modopts_t object

initialize global struct pamod_options

get module options and fill the global struct pamod_options

set defaults if necessary

get config file options

void set_pamod_defaults

(

void

)

Set default for global module option struct.

This function set default values for global pam_modopt_t structure to initialize it properly.

Returns:

Nothing to return.

---

Variable Documentation

pam_modopt_t pamod_options

C-Structure which contains pam-module options. In this global variable the pam-module options like debug level or the path of the configuration file are stored.