dir.h File Reference

Header for dir.c. More...

#include "lib/cc/compat_compiler.h"
#include "lib/testsupport/testsupport.h"

Go to the source code of this file.

Macros
#define	CPD_NONE   0
#define	CPD_CREATE   (1u << 0)
#define	CPD_CHECK   (1u << 1)
#define	CPD_GROUP_OK   (1u << 2)
#define	CPD_GROUP_READ   (1u << 3)
#define	CPD_CHECK_MODE_ONLY   (1u << 4)
#define	CPD_RELAX_DIRMODE_CHECK   (1u << 5)

Typedefs
typedef unsigned int	cpd_check_t

Functions
int	check_private_dir (const char *dirname, cpd_check_t check, const char *effective_user)
struct smartlist_t *	tor_listdir (const char *dirname)

Detailed Description

Header for dir.c.

Definition in file dir.h.

Macro Definition Documentation

CPD_CHECK

#define CPD_CHECK   (1u << 1)

Definition at line 23 of file dir.h.

CPD_CHECK_MODE_ONLY

#define CPD_CHECK_MODE_ONLY   (1u << 4)

Definition at line 26 of file dir.h.

CPD_CREATE

#define CPD_CREATE   (1u << 0)

Definition at line 22 of file dir.h.

CPD_GROUP_OK

#define CPD_GROUP_OK   (1u << 2)

Definition at line 24 of file dir.h.

CPD_GROUP_READ

#define CPD_GROUP_READ   (1u << 3)

Definition at line 25 of file dir.h.

CPD_NONE

#define CPD_NONE   0

Definition at line 21 of file dir.h.

CPD_RELAX_DIRMODE_CHECK

#define CPD_RELAX_DIRMODE_CHECK   (1u << 5)

Definition at line 27 of file dir.h.

Typedef Documentation

cpd_check_t

typedef unsigned int cpd_check_t

Possible behaviors for check_private_dir() on encountering a nonexistent directory; see that function's documentation for details.

Definition at line 20 of file dir.h.

Function Documentation

check_private_dir()

int check_private_dir	(	const char *	dirname,
		cpd_check_t	check,
		const char *	effective_user
	)

Check whether dirname exists and is private. If yes return 0. If dirname does not exist:

• if check&CPD_CREATE, try to create it and return 0 on success.
• if check&CPD_CHECK, and we think we can create it, return 0.
• if check&CPD_CHECK is false, and the directory exists, return 0.
• otherwise, return -1. If CPD_GROUP_OK is set, then it's okay if the directory is group-readable, but in all cases we create the directory mode 0700. If CPD_GROUP_READ is set, existing directory behaves as CPD_GROUP_OK and if the directory is created it will use mode 0750 with group read permission. Group read privileges also assume execute permission as norm for directories. If CPD_CHECK_MODE_ONLY is set, then we don't alter the directory permissions if they are too permissive: we just return -1. When effective_user is not NULL, check permissions against the given user and its primary group.

Definition at line 71 of file dir.c.

Referenced by check_and_create_data_directory(), check_or_create_data_subdir(), create_keys_directory(), dump_desc_create_dir(), dump_desc_init(), hs_check_service_private_dir(), hs_config_client_authorization(), storage_dir_new(), and store_permanent_client_auth_credentials().

tor_listdir()

struct smartlist_t * tor_listdir

(

const char *

dirname

)

Return a new list containing the filenames in the directory dirname. Return NULL on error or if dirname is not a directory.

Definition at line 307 of file dir.c.

Referenced by dump_desc_populate_fifo_from_directory(), find_and_remove_client_auth_creds_file(), hs_config_client_authorization(), list_family_key_files_impl(), load_client_keys(), and storage_dir_rescan().