File: pskc_set_key_data_b64secret.3

package info (click to toggle)
oath-toolkit 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 20,824 kB
  • ctags: 9,237
  • sloc: ansic: 54,713; sh: 13,738; yacc: 1,254; xml: 756; makefile: 353
file content (36 lines) | stat: -rw-r--r-- 1,421 bytes parent folder | download | duplicates (2)
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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "pskc_set_key_data_b64secret" 3 "2.6.1" "libpskc" "libpskc"
.SH NAME
pskc_set_key_data_b64secret \- API function
.SH SYNOPSIS
.B #include <pskc.h>
.sp
.BI "int pskc_set_key_data_b64secret(pskc_key_t * " key ", const char * " b64secret ");"
.SH ARGUMENTS
.IP "pskc_key_t * key" 12
a \fBpskc_key_t\fP handle, from \fBpskc_get_keypackage()\fP.
.IP "const char * b64secret" 12
the base64 encoded secret to set.
.SH "DESCRIPTION"
Set the PSKC KeyPackage Key Data Secret value in base64 as a
zero\-terminated string.  The \fIb64secret\fP data is copied into the
\fIkey\fP handle, so you may modify or deallocate the \fIb64secret\fP pointer
after calling this function.  The data is base64 decoded by this
function to verify data validity.  On errors, the old secret is not
modified.
.SH "RETURNS"
\fBPSKC_BASE64_ERROR\fP on base64 decoding errors,
\fBPSKC_MALLOC_ERROR\fP on memory allocation errors, or \fBPSKC_OK\fP on
success.
.SH "SINCE"
2.2.0
.SH "REPORTING BUGS"
Report bugs to <oath-toolkit-help@nongnu.org>.
libpskc home page: http://www.gnu.org/software/libpskc/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2012-2015 Simon Josefsson.
.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.