summaryrefslogtreecommitdiff
path: root/doc/man/asn1_write_value.3
blob: f560ef12604d83a28bf8c1cbb35cc394f6f54897 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "asn1_write_value" 3 "4.13" "libtasn1" "libtasn1"
.SH NAME
asn1_write_value \- API function
.SH SYNOPSIS
.B #include <libtasn1.h>
.sp
.BI "int asn1_write_value(asn1_node " node_root ", const char * " name ", const void * " ivalue ", int " len ");"
.SH ARGUMENTS
.IP "asn1_node node_root" 12
pointer to a structure
.IP "const char * name" 12
the name of the element inside the structure that you want to set.
.IP "const void * ivalue" 12
vector used to specify the value to set. If len is >0,
VALUE must be a two's complement form integer.  if len=0 *VALUE
must be a null terminated string with an integer value.
.IP "int len" 12
number of bytes of *value to use to set the value:
value[0]..value[len\-1] or 0 if value is a null terminated string
.SH "DESCRIPTION"
Set the value of one element inside a structure.

If an element is OPTIONAL and you want to delete it, you must use
the value=NULL and len=0.  Using "pkix.asn":

result=asn1_write_value(cert, "tbsCertificate.issuerUniqueID",
NULL, 0);

Description for each type:
.SH "INTEGER"
VALUE must contain a two's complement form integer.

value[0]=0xFF ,               len=1 \-> integer=\-1.
value[0]=0xFF value[1]=0xFF , len=2 \-> integer=\-1.
value[0]=0x01 ,               len=1 \-> integer= 1.
value[0]=0x00 value[1]=0x01 , len=2 \-> integer= 1.
value="123"                 , len=0 \-> integer= 123.
.SH "ENUMERATED"
As INTEGER (but only with not negative numbers).
.SH "BOOLEAN"
VALUE must be the null terminated string "TRUE" or
"FALSE" and LEN != 0.

value="TRUE" , len=1 \-> boolean=TRUE.
value="FALSE" , len=1 \-> boolean=FALSE.

OBJECT IDENTIFIER: VALUE must be a null terminated string with
each number separated by a dot (e.g. "1.2.3.543.1").  LEN != 0.

value="1 2 840 10040 4 3" , len=1 \-> OID=dsa\-with\-sha.
.SH "UTCTIME"
VALUE must be a null terminated string in one of these
formats: "YYMMDDhhmmssZ", "YYMMDDhhmmssZ",
"YYMMDDhhmmss+hh'mm'", "YYMMDDhhmmss\-hh'mm'",
"YYMMDDhhmm+hh'mm'", or "YYMMDDhhmm\-hh'mm'".  LEN != 0.

value="9801011200Z" , len=1 \-> time=Jannuary 1st, 1998
at 12h 00m Greenwich Mean Time
.SH "GENERALIZEDTIME"
VALUE must be in one of this format:
"YYYYMMDDhhmmss.sZ", "YYYYMMDDhhmmss.sZ",
"YYYYMMDDhhmmss.s+hh'mm'", "YYYYMMDDhhmmss.s\-hh'mm'",
"YYYYMMDDhhmm+hh'mm'", or "YYYYMMDDhhmm\-hh'mm'" where ss.s
indicates the seconds with any precision like "10.1" or "01.02".
LEN != 0

value="2001010112001.12\-0700" , len=1 \-> time=Jannuary
1st, 2001 at 12h 00m 01.12s Pacific Daylight Time

OCTET STRING: VALUE contains the octet string and LEN is the
number of octets.

value="$\backslash$x01$\backslash$x02$\backslash$x03" ,
len=3 \-> three bytes octet string
.SH "GENERALSTRING"
VALUE contains the generalstring and LEN is the
number of octets.

value="$\backslash$x01$\backslash$x02$\backslash$x03" ,
len=3 \-> three bytes generalstring

BIT STRING: VALUE contains the bit string organized by bytes and
LEN is the number of bits.

value="$\backslash$xCF" , len=6 \-> bit string="110011" (six
bits)
.SH "CHOICE"
if NAME indicates a choice type, VALUE must specify one of
the alternatives with a null terminated string. LEN != 0. Using
"pkix.asn"\:

result=asn1_write_value(cert,
"certificate1.tbsCertificate.subject", "rdnSequence",
1);
.SH "ANY"
VALUE indicates the der encoding of a structure.  LEN != 0.

SEQUENCE OF: VALUE must be the null terminated string "NEW" and
LEN != 0. With this instruction another element is appended in
the sequence. The name of this element will be "?1" if it's the
first one, "?2" for the second and so on.

Using "pkix.asn"\:

result=asn1_write_value(cert,
"certificate1.tbsCertificate.subject.rdnSequence", "NEW", 1);

SET OF: the same as SEQUENCE OF.  Using "pkix.asn":

result=asn1_write_value(cert,
"tbsCertificate.subject.rdnSequence.?LAST", "NEW", 1);
.SH "RETURNS"
\fBASN1_SUCCESS\fP if the value was set,
\fBASN1_ELEMENT_NOT_FOUND\fP if  \fIname\fP is not a valid element, and
\fBASN1_VALUE_NOT_VALID\fP if  \fIivalue\fP has a wrong format.
.SH COPYRIGHT
Copyright \(co 2006-2015 Free Software Foundation, Inc..
.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 libtasn1
is maintained as a Texinfo manual.  If the
.B info
and
.B libtasn1
programs are properly installed at your site, the command
.IP
.B info libtasn1
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/libtasn1/manual/
.PP