netatalk_conf.c File Reference

#include <arpa/inet.h>
#include <ctype.h>
#include <errno.h>
#include <grp.h>
#include <inttypes.h>
#include <netdb.h>
#include <netinet/in.h>
#include <pwd.h>
#include <regex.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/file.h>
#include <sys/param.h>
#include <sys/socket.h>
#include <time.h>
#include <utime.h>
#include <bstrlib.h>
#include <iniparser.h>
#include <atalk/afp.h>
#include <atalk/util.h>
#include <atalk/logger.h>
#include <atalk/ea.h>
#include <atalk/globals.h>
#include <atalk/iniparser_util.h>
#include <atalk/errchk.h>
#include <atalk/unix.h>
#include <atalk/cnid.h>
#include <atalk/dsi.h>
#include <atalk/asp.h>
#include <atalk/uuid.h>
#include <atalk/netatalk_conf.h>

Macros
#define	VOLPASSLEN   8
#define	UUID_PRINTABLE_STRING_LENGTH   37
#define	IS_VAR(a, b)
#define	EABUFSZ   4
#define	MAXPRESETLEN   100
#define	MAXVAL   1024

Functions
static int	rewrite_vol_uuid_conf (AFPObj *obj, struct vol *Volumes)
static char *	get_vol_uuid (const AFPObj *obj, const char *volname)
static int	do_check_ea_support (const struct vol *vol)
static void	check_ea_support (struct vol *vol)
static int	check_vol_acl_support (const struct vol *vol)
static char *	volxlate (const AFPObj *obj, char *dest, size_t destlen, const char *src, const struct passwd *pwd, const char *path, const char *volname)
static int	accessvol (const AFPObj *obj, const char *args, const char *name)
static int	hostaccessvol (const AFPObj *obj, const char *volname _U_, const char *args)
static const char *	getoption_str (const dictionary *conf, const char *vol, const char *opt, const char *defsec, const char *defval)
static char *	getoption_strdup (const dictionary *conf, const char *vol, const char *opt, const char *defsec, const char *defval)
static int	getoption_bool (const dictionary *conf, const char *vol, const char *opt, const char *defsec, int defval)
static int	getoption_int (const dictionary *conf, const char *vol, const char *opt, const char *defsec, int defval)
static int	vdgoption_bool (const dictionary *conf, const char *vol, const char *opt, const char *defsec, int defval)
static struct vol *	creatvol (AFPObj *obj, const struct passwd *pwd, const char *section, const char *name, const char *path_in, const char *preset)
static int	volfile_changed (AFPObj *obj)
static int	vol_section (const char *sec)
static int	readvolfile (AFPObj *obj, const struct passwd *pwent)
static int	setextmap (char *ext, char *type, char *creator)
static int	extmap_cmp (const void *map1, const void *map2)
static void	sortextmap (void)
static void	free_extmap (void)
static int	ext_cmp_key (const void *key, const void *obj)
struct extmap *	getextmap (const char *path)
struct extmap *	getdefextmap (void)
static int	readextmap (const char *file)
void	volume_unlink (struct vol *volume)
void	volume_free (struct vol *vol)
int	load_charset (struct vol *vol)
int	load_volumes (AFPObj *obj, lv_flags_t flags)
void	unload_volumes (AFPObj *obj)
struct vol *	getvolumes (void)
struct vol *	getvolbyvid (const uint16_t vid)
static char *	getuserbypath (const char *path)
struct vol *	getvolbypath (AFPObj *obj, const char *path)
struct vol *	getvolbyname (const char *name)
int	afp_config_parse (AFPObj *AFPObj, char *processname)
void	afp_config_free (AFPObj *obj)

Variables
static int	have_uservol = 0
static struct vol *	Volumes = NULL
static uint16_t	lastvid = 0
static struct extmap *	Extmap = NULL
static struct extmap *	Defextmap = NULL
static int	Extmap_cnt

Macro Definition Documentation

EABUFSZ

#define EABUFSZ   4

IS_VAR

#define IS_VAR	(		a,
			b )

Value:

(strncmp((a), (b), 2) == 0)

MAXPRESETLEN

#define MAXPRESETLEN   100

MAXVAL

#define MAXVAL   1024

UUID_PRINTABLE_STRING_LENGTH

#define UUID_PRINTABLE_STRING_LENGTH   37

VOLPASSLEN

#define VOLPASSLEN   8

Function Documentation

accessvol()

int accessvol ( const AFPObj * obj, const char * args, const char * name )

static

check access list

this function wants a string consisting of names seperated by comma or space. Names may be quoted within a pair of quotes. Groups are denoted by a leading @ symbol. Example: user1 user2, user3, "@group1", "@group2", "@group3", "user name1", "@group name1" A NULL argument allows everybody to have access. We return three things: -1: no list 0: list exists, but name isn't in it 1: in list

afp_config_free()

void afp_config_free

(

AFPObj *

obj

)

afp_config_parse()

int afp_config_parse	(	AFPObj *	AFPObj,
		char *	processname )

Initialize an AFPObj and options from ini config file

check_ea_support()

void check_ea_support ( struct vol * vol )

static

check_vol_acl_support()

int check_vol_acl_support ( const struct vol * vol )

static

Check whether a volume supports ACLs

Parameters

vol	(r) volume

Returns

0 if not, 1 if yes

creatvol()

struct vol * creatvol ( AFPObj * obj, const struct passwd * pwd, const char * section, const char * name, const char * path_in, const char * preset )

static

Create volume struct

Parameters

obj	(r) handle
pwd	(r) struct passwd of logged in user, may be NULL in master afpd
section	(r) volume name wo variables expanded (exactly as in iniconfig)
name	(r) volume name
path_in	(r) volume path
preset	(r) default preset, may be NULL

Returns

vol on success, NULL on error

do_check_ea_support()

int do_check_ea_support ( const struct vol * vol )

static

ext_cmp_key()

int ext_cmp_key ( const void * key, const void * obj )

static

extmap_cmp()

int extmap_cmp ( const void * map1, const void * map2 )

static

free_extmap()

void free_extmap ( void )

static

get_vol_uuid()

char * get_vol_uuid ( const AFPObj * obj, const char * volname )

static

getdefextmap()

struct extmap * getdefextmap

(

void

)

getextmap()

struct extmap * getextmap

(

const char *

path

)

getoption_bool()

int getoption_bool ( const dictionary * conf, const char * vol, const char * opt, const char * defsec, int defval )

static

Get boolean option from config, use default value if not set

Parameters

conf	(r) config handle
vol	(r) volume name (must be section name i.e. wo vars expanded)
opt	(r) option
defsec	(r) if "option" is not found in "vol", try to find it in section "defsec"
defval	(r) if neither "vol" nor "defsec" contain "opt" return "defval"

Returns

const option string from "vol" or "defsec", or "defval" if not found

getoption_int()

int getoption_int ( const dictionary * conf, const char * vol, const char * opt, const char * defsec, int defval )

static

Get integer option from config, use default value if not set

Parameters

conf	(r) config handle
vol	(r) volume name (must be section name i.e. wo vars expanded)
opt	(r) option
defsec	(r) if "option" is not found in "vol", try to find it in section "defsec"
defval	(r) if neither "vol" nor "defsec" contain "opt" return "defval"

Returns

int option from "vol" or "defsec", or "defval" if not found

getoption_str()

const char * getoption_str ( const dictionary * conf, const char * vol, const char * opt, const char * defsec, const char * defval )

static

Get option string from config, use default value if not set

Parameters

conf	(r) config handle
vol	(r) volume name (must be section name i.e. wo vars expanded)
opt	(r) option
defsec	(r) if "option" is not found in "vol", try to find it in section "defsec"
defval	(r) if neither "vol" nor "defsec" contain "opt" return "defval"

Returns

const option string from "vol" or "defsec", or "defval" if not found

getoption_strdup()

char * getoption_strdup ( const dictionary * conf, const char * vol, const char * opt, const char * defsec, const char * defval )

static

Get option string from config, use default value if not set Returns a dynamically allocated string which caller must free

Parameters

conf	(r) config handle
vol	(r) volume name (must be section name i.e. wo vars expanded)
opt	(r) option
defsec	(r) if "option" is not found in "vol", try to find it in section "defsec"
defval	(r) if neither "vol" nor "defsec" contain "opt" return "defval"

Returns

dynamically allocated option string from "vol" or "defsec", or "defval" if not found

getuserbypath()

char * getuserbypath ( const char * path )

static

getvolbyname()

struct vol * getvolbyname

(

const char *

name

)

getvolbypath()

struct vol * getvolbypath	(	AFPObj *	obj,
		const char *	path )

Search volume by path, creating user home vols as necessary

Path may be absolute or relative. Ordinary volume structs are created when the ini config is initially parsed (load_volumes()), but user volumes are as load_volumes() only can create the user volume of the logged in user in an AFP session in afpd, but not when called from e.g. cnid_metad or dbd. Both cnid_metad and dbd thus need a way to lookup and create struct vols for user home by path. This is what this func does as well.

(1) Search "normal" volume list (2) Check if theres a [Homes] section, load_volumes() remembers this for us (3) If there is, match "path" with "basedir regex" to get the user home parent dir (4) Built user home path by appending the basedir matched in (3) and appending the username (5) The next path element then is the username (5b) getvolbypath() assumes that the user home directory has the same name as the username. If that is not true, getuserbypath() is called and tries to retrieve the username from the directory owner, checking its validity (6) Append [Homes]->path subdirectory if defined (7) Create volume

Parameters

obj	(rw) handle
path	(r) path, may be relative or absolute

getvolbyvid()

struct vol * getvolbyvid

(

const uint16_t

vid

)

getvolumes()

struct vol * getvolumes

(

void

)

hostaccessvol()

int hostaccessvol ( const AFPObj * obj, const char *volname _U_, const char * args )

static

load_charset()

int load_charset

(

struct vol *

vol

)

Load charsets for a volume

load_volumes()

int load_volumes	(	AFPObj *	obj,
		lv_flags_t	flags )

Initialize volumes and load ini configfile

Parameters

obj	(r) handle
flags	(r) flags controlling volume load behaviour: LV_DEFAULT: load shares in a user/session context, this honors authorisation LV_ALL: load shares that are available in the config file LV_FORCE: reload file even though the timestamp wasn't changed

readextmap()

int readextmap ( const char * file )

static

readvolfile()

int readvolfile ( AFPObj * obj, const struct passwd * pwent )

static

Read volumes from iniconfig and add the volumes contained within to the global volume list. This gets called from the forked afpd childs. The master now reads this too for Zeroconf announcements.

rewrite_vol_uuid_conf()

int rewrite_vol_uuid_conf ( AFPObj * obj, struct vol * Volumes )

static

setextmap()

int setextmap ( char * ext, char * type, char * creator )

static

sortextmap()

void sortextmap ( void )

static

unload_volumes()

void unload_volumes

(

AFPObj *

obj

)

vdgoption_bool()

int vdgoption_bool ( const dictionary * conf, const char * vol, const char * opt, const char * defsec, int defval )

static

Get boolean option from volume, default section or global - use default value if not set

Order of precedence: volume -> default section -> global -> default value

"vdg" means volume, default section or global

Parameters

conf	(r) config handle
vol	(r) volume name (must be section name i.e. wo vars expanded)
opt	(r) option
defsec	(r) if "option" is not found in "vol", try to find it in section "defsec"
defval	(r) if neither "vol" nor "defsec" contain "opt" return "defval"

Returns

const option string from "vol" or "defsec", or "defval" if not found

vol_section()

int vol_section ( const char * sec )

static

volfile_changed()

int volfile_changed ( AFPObj * obj )

static

volume_free()

void volume_free

(

struct vol *

vol

)

Free all resources allocated in a struct vol in load_volumes()

Actually opening a volume (afp_openvol()) will allocate additional resources which are freed in closevol()

volume_unlink()

void volume_unlink

(

struct vol *

volume

)

Remove a volume from the linked list of volumes

volxlate()

char * volxlate ( const AFPObj * obj, char * dest, size_t destlen, const char * src, const struct passwd * pwd, const char * path, const char * volname )

static

Variable Documentation

Defextmap

struct extmap * Defextmap = NULL

static

Extmap

struct extmap* Extmap = NULL

static

Extmap_cnt

int Extmap_cnt

static

have_uservol

int have_uservol = 0

static

lastvid

uint16_t lastvid = 0

static

Volumes

struct vol* Volumes = NULL

static