summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_store_commitment.3
blob: d00864e60091ba128ae984d4421829327cadd791 (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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_store_commitment" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_store_commitment \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_store_commitment(const char * " db_name ", gnutls_tdb_t " tdb ", const char * " host ", const char * " service ", gnutls_digest_algorithm_t " hash_algo ", const gnutls_datum_t * " hash ", time_t " expiration ", unsigned int " flags ");"
.SH ARGUMENTS
.IP "const char * db_name" 12
A file specifying the stored keys (use NULL for the default)
.IP "gnutls_tdb_t tdb" 12
A storage structure or NULL to use the default
.IP "const char * host" 12
The peer's name
.IP "const char * service" 12
non\-NULL if this key is specific to a service (e.g. http)
.IP "gnutls_digest_algorithm_t hash_algo" 12
The hash algorithm type
.IP "const gnutls_datum_t * hash" 12
The raw hash
.IP "time_t expiration" 12
The expiration time (use 0 to disable expiration)
.IP "unsigned int flags" 12
should be 0 or \fBGNUTLS_SCOMMIT_FLAG_ALLOW_BROKEN\fP.
.SH "DESCRIPTION"
This function will store the provided hash commitment to
the list of stored public keys. The key with the given
hash will be considered valid until the provided expiration time.

The  \fItdb\fP variable if non\-null specifies a custom backend for
the storage of entries. If it is NULL then the
default file backend will be used.

Note that this function is not thread safe with the default backend.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
negative error value.
.SH "SINCE"
3.0
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP