%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@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

%%	module

#include "dk4conf.h"
#include "dk4fopd.h"

FILE *
dk4fopen(const dkChar *name, const dkChar *mode, int tests, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
  return (dk4fopen_wc(name, mode, tests, erp));
#else
  return (dk4fopen_c8(name, mode, tests, erp));
#endif
}

int
dk4fopen_check(const dkChar *name, int ww, int tests, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
  return (dk4fopen_check_wc(name, ww, tests, erp));
#else
  return (dk4fopen_check_c8(name, ww, tests, erp));
#endif
}