summaryrefslogtreecommitdiff
path: root/support/dktools/dk3chks.h
blob: 8730a2199c7b58c821b7aa0cee04a3a11af00c48 (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
/*
Copyright (C) 2011-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: dk3chks.ctr
*/

/**	@file dk3chks.h Header file for the dk3chks module.
*/

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


#line 10 "dk3chks.ctr"

#include "dk3conf.h"
#include "dk3types.h"

#ifdef __cplusplus
extern "C" {
#endif

/**	Get checksum type for a given name.
	@param	n	Message digest name ("MD5", "SHA-1", "SHA-224",
	"SHA-256", "SHA-384", "SHA-512", or "RIPEMD-160").
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Integer representation (see @ref mdtypes) on success,
	-1 on error.
*/
int
dk3checksum_get_type_app(dkChar const *n, dk3_app_t *app);

/**	Build checksum for a file.
	@param	db	Destination buffer.
	@param	sz	Size of destination buffer.
	@param	fn	File name to process.
	@param	cst	Checksum type (message digest type,
	see @ref mdtypes).
	@param	cse	Binary to text encoding for message digest
	(see @ref dataencoding).
	@param	app	Application structure for diagnostics, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk3checksum_build_app(
  char *db, size_t sz, dkChar const *fn, int cst, int cse, dk3_app_t *app
);

/**	Get string length produced for a message digest and encoding type.
	@param	cst	Message digest type, see @ref mdtypes.
	@param	cse	Binary to text encoding, see @ref dataencoding.
	@return	Number of characters produced.
*/
size_t
dk3checksum_length(int cst, int cse);

/**	Get name for message digest type.
	@param	tp	Digest type, see @ref mdtypes.
	@return	Name for digest type.
*/
dkChar const *
dk3checksum_get_type_name(int tp);

#ifdef __cplusplus
}
#endif




#endif