summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2016-11-06 16:56:47 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2016-11-06 16:56:47 +0000
commitd8ef8ea69ad9e88b62b752730f08f6c8d036bbf6 (patch)
tree0e57f8f068f504e951142945d33cad85371fe715 /lib
parentd18745393c061cb2b8ea238a7e078ec7f8ce0f42 (diff)
some minor cleanup;
Diffstat (limited to 'lib')
-rw-r--r--lib/libcrypto/man/ASN1_OBJECT_new.310
-rw-r--r--lib/libcrypto/man/ASN1_STRING_length.36
-rw-r--r--lib/libcrypto/man/ASN1_STRING_new.34
-rw-r--r--lib/libcrypto/man/ASN1_STRING_print_ex.341
-rw-r--r--lib/libcrypto/man/ASN1_generate_nconf.324
5 files changed, 42 insertions, 43 deletions
diff --git a/lib/libcrypto/man/ASN1_OBJECT_new.3 b/lib/libcrypto/man/ASN1_OBJECT_new.3
index 9c73dcb0ce7..cdae2be12cf 100644
--- a/lib/libcrypto/man/ASN1_OBJECT_new.3
+++ b/lib/libcrypto/man/ASN1_OBJECT_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_OBJECT_new.3,v 1.4 2016/11/06 15:52:50 jmc Exp $
+.\" $OpenBSD: ASN1_OBJECT_new.3,v 1.5 2016/11/06 16:56:46 jmc Exp $
.\"
.Dd $Mdocdate: November 6 2016 $
.Dt ASN1_OBJECT_NEW 3
@@ -6,7 +6,7 @@
.Sh NAME
.Nm ASN1_OBJECT_new ,
.Nm ASN1_OBJECT_free
-.Nd ASN1 object allocation functions
+.Nd ASN.1 object allocation functions
.Sh SYNOPSIS
.In openssl/asn1.h
.Ft ASN1_OBJECT *
@@ -20,7 +20,7 @@
.Sh DESCRIPTION
The ASN1_OBJECT allocation routines allocate and free an
.Vt ASN1_OBJECT
-structure, which represents an ASN1 OBJECT IDENTIFIER.
+structure, which represents an ASN.1 OBJECT IDENTIFIER.
.Pp
.Fn ASN1_OBJECT_new
allocates and initializes an
@@ -32,13 +32,13 @@ frees up the
.Vt ASN1_OBJECT
structure
.Fa a .
-.Sh NOTES
+.Pp
Although
.Fn ASN1_OBJECT_new
allocates a new
.Vt ASN1_OBJECT
structure, it is almost never used in applications.
-The ASN1 object utility functions such as
+The ASN.1 object utility functions such as
.Xr OBJ_nid2obj 3
are used instead.
.Sh RETURN VALUES
diff --git a/lib/libcrypto/man/ASN1_STRING_length.3 b/lib/libcrypto/man/ASN1_STRING_length.3
index 1fa794fc466..f76e867d6a4 100644
--- a/lib/libcrypto/man/ASN1_STRING_length.3
+++ b/lib/libcrypto/man/ASN1_STRING_length.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_STRING_length.3,v 1.3 2016/11/06 15:52:50 jmc Exp $
+.\" $OpenBSD: ASN1_STRING_length.3,v 1.4 2016/11/06 16:56:46 jmc Exp $
.\"
.Dd $Mdocdate: November 6 2016 $
.Dt ASN1_STRING_LENGTH 3
@@ -121,8 +121,8 @@ returns the type of
.Fa x ,
using standard constants such as
.Dv V_ASN1_OCTET_STRING .
-.Sh NOTES
-Almost all ASN1 types in OpenSSL are represented as
+.Pp
+Almost all ASN.1 types in OpenSSL are represented as
.Vt ASN1_STRING
structures.
Other types such as
diff --git a/lib/libcrypto/man/ASN1_STRING_new.3 b/lib/libcrypto/man/ASN1_STRING_new.3
index 5810d5a15f9..81fa9386aa6 100644
--- a/lib/libcrypto/man/ASN1_STRING_new.3
+++ b/lib/libcrypto/man/ASN1_STRING_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_STRING_new.3,v 1.3 2016/11/06 15:52:50 jmc Exp $
+.\" $OpenBSD: ASN1_STRING_new.3,v 1.4 2016/11/06 16:56:46 jmc Exp $
.\"
.Dd $Mdocdate: November 6 2016 $
.Dt ASN1_STRING_NEW 3
@@ -38,7 +38,7 @@ structure of type
.Fn ASN1_STRING_free
frees up
.Fa a .
-.Sh NOTES
+.Pp
Other string types call the ASN1_STRING functions.
For example
.Fn ASN1_OCTET_STRING_new
diff --git a/lib/libcrypto/man/ASN1_STRING_print_ex.3 b/lib/libcrypto/man/ASN1_STRING_print_ex.3
index 75a07a0b6e3..19ff081f792 100644
--- a/lib/libcrypto/man/ASN1_STRING_print_ex.3
+++ b/lib/libcrypto/man/ASN1_STRING_print_ex.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_STRING_print_ex.3,v 1.3 2016/11/06 15:52:50 jmc Exp $
+.\" $OpenBSD: ASN1_STRING_print_ex.3,v 1.4 2016/11/06 16:56:46 jmc Exp $
.\"
.Dd $Mdocdate: November 6 2016 $
.Dt ASN1_STRING_PRINT_EX 3
@@ -33,14 +33,14 @@ These functions output an
structure.
.Vt ASN1_STRING
is used to
-represent all the ASN1 string types.
+represent all the ASN.1 string types.
.Pp
.Fn ASN1_STRING_print_ex
outputs
.Fa str
to
.Fa out ,
-the format is determined by the options
+the format being determined by the options
.Fa flags .
.Fn ASN1_STRING_print_ex_fp
is identical except it outputs to
@@ -56,15 +56,16 @@ but using a different format to
.Fn ASN1_STRING_print_ex .
It replaces unprintable characters (other than CR, LF) with
.Sq \&. .
-.Sh NOTES
+.Pp
.Fn ASN1_STRING_print
is a legacy function which should be avoided in new
applications.
.Pp
-Although there are a large number of options frequently
+Although there are a large number of options,
+.Dv ASN1_STRFLGS_RFC2253
+is often suitable, or on UTF-8 terminals
.Dv ASN1_STRFLGS_RFC2253
-is suitable, or on UTF8 terminals
-.Dv ASN1_STRFLGS_RFC2253 No &
+and
.Pf ~ Dv ASN1_STRFLGS_ESC_MSB .
.Pp
The complete set of supported options for
@@ -74,7 +75,7 @@ is listed below.
Various characters can be escaped.
If
.Dv ASN1_STRFLGS_ESC_2253
-is set, the characters determined by RFC2253 are escaped.
+is set, the characters determined by RFC 2253 are escaped.
If
.Dv ASN1_STRFLGS_ESC_CTRL
is set, control characters are escaped.
@@ -82,15 +83,14 @@ If
.Dv ASN1_STRFLGS_ESC_MSB
is set, characters with the MSB set are escaped: this option should
.Em not
-be used if the terminal correctly interprets UTF8 sequences.
+be used if the terminal correctly interprets UTF-8 sequences.
.Pp
Escaping takes several forms.
-.Pp
-If the character being escaped is a 16 bit character then the form "\eUXXXX"
+If the character being escaped is a 16-bit character then the form "\eUXXXX"
is used using exactly four characters for the hex representation.
If it is 32 bits then "\eWXXXXXXXX" is used using eight characters
of its hex representation.
-These forms will only be used if UTF8 conversion is not set (see below).
+These forms will only be used if UTF-8 conversion is not set (see below).
.Pp
Printable characters are normally escaped using the backslash
.Pq Sq \e
@@ -104,24 +104,24 @@ representation.
.Pp
If
.Dv ASN1_STRFLGS_UTF8_CONVERT
-is set, then characters are converted to UTF8 format first.
-If the terminal supports the display of UTF8 sequences then this
-option will correctly display multi byte characters.
+is set, then characters are converted to UTF-8 format first.
+If the terminal supports the display of UTF-8 sequences then this
+option will correctly display multi-byte characters.
.Pp
If
.Dv ASN1_STRFLGS_IGNORE_TYPE
is set, then the string type is not interpreted at all:
everything is assumed to be one byte per character.
This is primarily for debugging purposes and can result
-in confusing output in multi character strings.
+in confusing output in multi-character strings.
.Pp
If
.Dv ASN1_STRFLGS_SHOW_TYPE
-is set, then the string type itself is printed out before its value
-(for example "BMPSTRING"), this actually uses
+is set, then the string type itself is printed before its value
+(for example "BMPSTRING"), using
.Fn ASN1_tag2str .
.Pp
-The content of a string instead of being interpreted can be "dumped":
+Instead of being interpreted the contents of a string can be "dumped":
this just outputs the value of the string using the form #XXXX
using hex format for each octet.
.Pp
@@ -129,7 +129,7 @@ If
.Dv ASN1_STRFLGS_DUMP_ALL
is set, then any type is dumped.
.Pp
-Normally non character string types (such as OCTET STRING)
+Normally non-character string types (such as OCTET STRING)
are assumed to be one byte per character; if
.Dv ASN1_STRFLGS_DUMP_UNKNOWN
is set, then they will be dumped instead.
@@ -149,5 +149,4 @@ It is equivalent to
.Dv ASN1_STRFLGS_DUMP_UNKNOWN |
.Dv ASN1_STRFLGS_DUMP_DER .
.Sh SEE ALSO
-.Xr ASN1_tag2str 3 ,
.Xr X509_NAME_print_ex 3
diff --git a/lib/libcrypto/man/ASN1_generate_nconf.3 b/lib/libcrypto/man/ASN1_generate_nconf.3
index 1fd7f38d263..39929782ee1 100644
--- a/lib/libcrypto/man/ASN1_generate_nconf.3
+++ b/lib/libcrypto/man/ASN1_generate_nconf.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ASN1_generate_nconf.3,v 1.5 2016/11/06 15:52:50 jmc Exp $
+.\" $OpenBSD: ASN1_generate_nconf.3,v 1.6 2016/11/06 16:56:46 jmc Exp $
.\"
.Dd $Mdocdate: November 6 2016 $
.Dt ASN1_GENERATE_NCONF 3
@@ -6,7 +6,7 @@
.Sh NAME
.Nm ASN1_generate_nconf ,
.Nm ASN1_generate_v3
-.Nd ASN1 generation functions
+.Nd ASN.1 generation functions
.Sh SYNOPSIS
.In openssl/asn1.h
.Ft ASN1_TYPE *
@@ -20,7 +20,7 @@
.Fa "X509V3_CTX *cnf"
.Fc
.Sh DESCRIPTION
-These functions generate the ASN1 encoding of a string in an
+These functions generate the ASN.1 encoding of a string in an
.Vt ASN1_TYPE
structure.
.Pp
@@ -93,7 +93,7 @@ The
.Ar value
string must not be present.
.It Cm INTEGER , INT
-Encodes an ASN1 INTEGER type.
+Encodes an ASN.1 INTEGER type.
The
.Ar value
string represents the value of the integer.
@@ -102,24 +102,24 @@ and is normally interpreted as a decimal value unless the prefix
.Cm 0x
is included.
.It Cm ENUMERATED , ENUM
-Encodes the ASN1 ENUMERATED type.
+Encodes the ASN.1 ENUMERATED type.
It is otherwise identical to
.Cm INTEGER .
.It Cm OBJECT , OID
-Encodes an ASN1 OBJECT IDENTIFIER.
+Encodes an ASN.1 OBJECT IDENTIFIER.
The
.Ar value
string can be a short name, a long name, or numerical format.
.It Cm UTCTIME , UTC
-Encodes an ASN1 UTCTime structure.
+Encodes an ASN.1 UTCTime structure.
The value should be in the format
.Ar YYMMDDHHMMSSZ .
.It Cm GENERALIZEDTIME , GENTIME
-Encodes an ASN1 GeneralizedTime structure.
+Encodes an ASN.1 GeneralizedTime structure.
The value should be in the format
.Ar YYYYMMDDHHMMSSZ .
.It Cm OCTETSTRING , OCT
-Encodes an ASN1 OCTET STRING.
+Encodes an ASN.1 OCTET STRING.
.Ar value
represents the contents of this structure.
The format strings
@@ -129,7 +129,7 @@ and
can be used to specify the format of
.Ar value .
.It Cm BITSTRING , BITSTR
-Encodes an ASN1 BIT STRING.
+Encodes an ASN.1 BIT STRING.
.Ar value
represents the contents of this structure.
The format strings
@@ -163,7 +163,7 @@ The format can be
or
.Cm UTF8 .
.It Cm SEQUENCE , SEQ , SET
-Formats the result as an ASN1 SEQUENCE or SET type.
+Formats the result as an ASN.1 SEQUENCE or SET type.
.Ar value
should be a section name which will contain the contents.
The field names in the section are ignored
@@ -215,7 +215,7 @@ If
.Cm UTF8
is specified, then the
.Ar value
-string must be a valid UTF8 string.
+string must be a valid UTF-8 string.
For
.Cm HEX ,
the output must be a set of hex digits.