boringssl

History

David Benjamin 687759db79 Restore obj_mac.num from upstream. This got reset at some point, but not the files generated from it. obj_mac.num is an input/output parameter to objects.pl and used to keep the NIDs stable. Imported from f2d678e6e89b6508147086610e985d4e8416e867, the point at which we forked. Change-Id: Ifd52b1aaa55054d37bc1217f2375a93302839e23 Reviewed-on: https://boringssl-review.googlesource.com/2472 Reviewed-by: Adam Langley <agl@google.com>		2014-12-04 22:12:55 +00:00
..
CMakeLists.txt	Inital import.	2014-06-20 13:17:32 -07:00
obj_dat.h	Don't export obj_dat.h.	2014-09-02 22:41:28 +00:00
obj_dat.pl	Add documentation for the OID scripts.	2014-12-04 22:12:26 +00:00
obj_error.c	Move public headers to include/openssl/	2014-07-14 22:42:18 +00:00
obj_mac.num	Restore obj_mac.num from upstream.	2014-12-04 22:12:55 +00:00
obj_xref.c	Inital import.	2014-06-20 13:17:32 -07:00
obj_xref.h	Don't include undef in cross reference table.	2014-12-04 22:11:13 +00:00
obj_xref.pl	Add documentation for the OID scripts.	2014-12-04 22:12:26 +00:00
obj_xref.txt	Inital import.	2014-06-20 13:17:32 -07:00
obj.c	Don't export obj_dat.h.	2014-09-02 22:41:28 +00:00
objects.pl	Add documentation for the OID scripts.	2014-12-04 22:12:26 +00:00
objects.txt	Inital import.	2014-06-20 13:17:32 -07:00
README	Add documentation for the OID scripts.	2014-12-04 22:12:26 +00:00

README

OID information is generated via a series of perl scripts. In order, the full
list of commands to run are:

        perl objects.pl objects.txt obj_mac.num ../../include/openssl/obj_mac.h
        perl obj_dat.pl ../../include/openssl/obj_mac.h obj_dat.h
        perl obj_xref.pl obj_mac.num obj_xref.txt > obj_xref.h

objects.txt contains the list of all built-in OIDs. It is processed by
objects.pl to output obj_mac.num and obj_mac.h. obj_mac.num is the list of NID
values for each OID. This is an input/output parameter so NID values are stable
across regenerations. obj_mac.h is the header which defines macros for all the
built-in OIDs in C.

obj_mac.h is read by obj_dat.pl to generate obj_dat.h. obj_dat.h contains the
ASN1_OBJECTs corresponding to built-in OIDs themselves along with lookup tables
for search by short name, OID, etc.

obj_mac.num and obj_xref.txt are read by obj_xref.pl to generate
obj_xref.h. obj_xref.txt links signature OIDs to corresponding public key
algorithms and digests. obj_xref.h contains lookup tables for querying this
information in both directions.

Dependency graph:

                        objects.txt
                            |
                            V
                       [objects.pl] <--+
                         /      \      |
                        V        V     |
                  obj_mac.h    obj_mac.num  obj_xref.txt
                      |              \      /
                      V               V    V
                 [obj_dat.pl]      [obj_xref.pl]
                      |                  |
                      V                  V
                  obj_dat.h         obj_xref.h