summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fopwc.h
blob: 431f5b31e260e080cbda9dc7b7895097d9387cf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4fopwc.ctr
*/

#ifndef DK4FOPWC_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4FOPWC_H_INCLUDED 1


#line 10 "dk4fopwc.ctr"

/**	@file
	Open file, apply additional security
	checks before attempting to open the file.

	Attempts to open a directory as a file are rejected.

	Further optional checks can be applied to avoid:
	- writing to non-regular files,
	- writing to files with any symbolic link component in the path,
	- writing to files via symbolic link,
	- writing to files via symbolic link if link owner differs
	  from file owner.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#ifndef DK4NUMCO_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4numco.h"
#else
#include <dktools-4/dk4numco.h>
#endif
#endif

#ifndef DK4FOPT_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4fopt.h"
#else
#include <dktools-4/dk4fopt.h>
#endif
#endif

#ifndef STDIO_H_INCLUDED
#include <stdio.h>
#define	STDIO_H_INCLUDED 1
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Open a file after doing security checks.
	CRT on Windows: Required.
	@param	name	File name to open.
	@param	mode	Opening mode.
	@param	tests	Set of tests.
	@param	erp	Error report, may be NULL.
	@return	Pointer to open file on success, NULL on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if name is NULL,
	- DK4_E_SYNTAX<br>
	  if name does not refer to a regular file,
	- DK4_E_NOT_SUPPORTED<br>
	  if no functions for wchar_t file names are available,
	- DK4_E_SEC_CHECK<br>
	  with failed check id in iDetails1 if access is denied by additional
	  security checks,
	- DK4_E_OPEN_WRITE_FAILED<br>
	  or DK4_E_OPEN_READ_FAILED with errno value in iDetails1 if fopen()
	  failed.

*/
FILE *
dk4fopen_wc(const wchar_t *name, const wchar_t *mode, int tests, dk4_er_t *erp);

/**	Check whether we can allow to open the file.
	The file must be a regular file.
	Only POSIX: For root we deny opening for writing via symlink.
	For all users we deny opening for writing via symlink
	if the link owner is not the real file owner.

	CRT on Windows: Required.
	@param	name	File name to check.
	@param	ww	Flag: Write access wanted.
	@param	tests	Set of tests.
	@param	erp	Error report, may be NULL.
	@return	1 if opening the file is allowed, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if name is NULL,
	- DK4_E_SYNTAX<br>
	  if name is not a regular file,
	- DK4_E_SEC_CHECK<br>
	  if access to a symlink target is denied symlink owner and target
	  owner differ.

*/
int
dk4fopen_check_wc(const wchar_t *name, int ww, int tests, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif




#endif