summaryrefslogtreecommitdiff
path: root/support/dktools/dk4fopd.h
blob: ffdcd30e53f8b1d5a562d6e132d3b75ad79bc5ae (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
/*
	WARNING: This file was generated by dkct.
	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: dk4fopd.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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


#line 10 "dk4fopd.ctr"

/**	@file
	Open file with additional security
	checks, file name is specified in dkChar characters.
*/

#include "dk4conf.h"
#include "dk4fopc8.h"

#if DK4_CHAR_SIZE > 1
#include "dk4fopwc.h"
#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, see dk4fopc8.h.
	@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_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(const dkChar *name, const dkChar *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(const dkChar *name, int ww, int tests, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif