kris/boringssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
58104889ad
boringssl/crypto/obj/README

38 lines
1.6 KiB
Plaintext
Raw Normal View History

Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
OID information is generated via a series of perl scripts. In order, the full
list of commands to run are:
Rename obj_mac.h to nid.h and make it a multiply-includable header. obj_mac.h is missing #include guards, so one cannot use NIDs without pulling in the OBJ_* functions which depend on the giant OID table. Give it #include guards, tidy up the style slightly, and also rename it to nid.h which is a much more reasonable name. obj_mac.h is kept as a forwarding header as, despite it being a little screwy, some code #includes it anyway. BUG=chromium:499653 Change-Id: Iec0b3f186c02e208ff1f7437bf27ee3a5ad004b7 Reviewed-on: https://boringssl-review.googlesource.com/7562 Reviewed-by: Steven Valdez <svaldez@google.com> Reviewed-by: David Benjamin <davidben@google.com>
2016-03-25 22:07:08 +00:00
perl objects.pl objects.txt obj_mac.num ../../include/openssl/nid.h
perl obj_dat.pl ../../include/openssl/nid.h obj_dat.h
Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
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
Rename obj_mac.h to nid.h and make it a multiply-includable header. obj_mac.h is missing #include guards, so one cannot use NIDs without pulling in the OBJ_* functions which depend on the giant OID table. Give it #include guards, tidy up the style slightly, and also rename it to nid.h which is a much more reasonable name. obj_mac.h is kept as a forwarding header as, despite it being a little screwy, some code #includes it anyway. BUG=chromium:499653 Change-Id: Iec0b3f186c02e208ff1f7437bf27ee3a5ad004b7 Reviewed-on: https://boringssl-review.googlesource.com/7562 Reviewed-by: Steven Valdez <svaldez@google.com> Reviewed-by: David Benjamin <davidben@google.com>
2016-03-25 22:07:08 +00:00
objects.pl to output obj_mac.num and nid.h. obj_mac.num is the list of NID
Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
values for each OID. This is an input/output parameter so NID values are stable
Rename obj_mac.h to nid.h and make it a multiply-includable header. obj_mac.h is missing #include guards, so one cannot use NIDs without pulling in the OBJ_* functions which depend on the giant OID table. Give it #include guards, tidy up the style slightly, and also rename it to nid.h which is a much more reasonable name. obj_mac.h is kept as a forwarding header as, despite it being a little screwy, some code #includes it anyway. BUG=chromium:499653 Change-Id: Iec0b3f186c02e208ff1f7437bf27ee3a5ad004b7 Reviewed-on: https://boringssl-review.googlesource.com/7562 Reviewed-by: Steven Valdez <svaldez@google.com> Reviewed-by: David Benjamin <davidben@google.com>
2016-03-25 22:07:08 +00:00
across regenerations. nid.h is the header which defines macros for all the
Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
built-in OIDs in C.
Rename obj_mac.h to nid.h and make it a multiply-includable header. obj_mac.h is missing #include guards, so one cannot use NIDs without pulling in the OBJ_* functions which depend on the giant OID table. Give it #include guards, tidy up the style slightly, and also rename it to nid.h which is a much more reasonable name. obj_mac.h is kept as a forwarding header as, despite it being a little screwy, some code #includes it anyway. BUG=chromium:499653 Change-Id: Iec0b3f186c02e208ff1f7437bf27ee3a5ad004b7 Reviewed-on: https://boringssl-review.googlesource.com/7562 Reviewed-by: Steven Valdez <svaldez@google.com> Reviewed-by: David Benjamin <davidben@google.com>
2016-03-25 22:07:08 +00:00
nid.h is read by obj_dat.pl to generate obj_dat.h. obj_dat.h contains the
Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
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 |
Rename obj_mac.h to nid.h and make it a multiply-includable header. obj_mac.h is missing #include guards, so one cannot use NIDs without pulling in the OBJ_* functions which depend on the giant OID table. Give it #include guards, tidy up the style slightly, and also rename it to nid.h which is a much more reasonable name. obj_mac.h is kept as a forwarding header as, despite it being a little screwy, some code #includes it anyway. BUG=chromium:499653 Change-Id: Iec0b3f186c02e208ff1f7437bf27ee3a5ad004b7 Reviewed-on: https://boringssl-review.googlesource.com/7562 Reviewed-by: Steven Valdez <svaldez@google.com> Reviewed-by: David Benjamin <davidben@google.com>
2016-03-25 22:07:08 +00:00
nid.h obj_mac.num obj_xref.txt
Add documentation for the OID scripts. Make the commands print a short usage summary and add a README file that explains the dependencies. Change-Id: I0c3f0713749ecfca23afaa2b536ac70dbdd7db0a Reviewed-on: https://boringssl-review.googlesource.com/2471 Reviewed-by: Adam Langley <agl@google.com>
2014-12-04 20:48:49 +00:00
| \ /
V V V
[obj_dat.pl] [obj_xref.pl]
| |
V V
obj_dat.h obj_xref.h
Reference in New Issue Copy Permalink