openssl/crypto/objects
Dr. Matthias St. Pierre 0c994d54af Reorganize private crypto header files
Currently, there are two different directories which contain internal
header files of libcrypto which are meant to be shared internally:

While header files in 'include/internal' are intended to be shared
between libcrypto and libssl, the files in 'crypto/include/internal'
are intended to be shared inside libcrypto only.

To make things complicated, the include search path is set up in such
a way that the directive #include "internal/file.h" could refer to
a file in either of these two directoroes. This makes it necessary
in some cases to add a '_int.h' suffix to some files to resolve this
ambiguity:

  #include "internal/file.h"      # located in 'include/internal'
  #include "internal/file_int.h"  # located in 'crypto/include/internal'

This commit moves the private crypto headers from

  'crypto/include/internal'  to  'include/crypto'

As a result, the include directives become unambiguous

  #include "internal/file.h"       # located in 'include/internal'
  #include "crypto/file.h"         # located in 'include/crypto'

hence the superfluous '_int.h' suffixes can be stripped.

The files 'store_int.h' and 'store.h' need to be treated specially;
they are joined into a single file.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9681)
2019-09-27 23:57:58 +02:00
..
build.info
o_names.c Reorganize private crypto header files 2019-09-27 23:57:58 +02:00
obj_dat.c Reorganize private crypto header files 2019-09-27 23:57:58 +02:00
obj_dat.h Fix GOST OID 2019-05-24 12:36:06 +03:00
obj_dat.pl Update generator copyright year. 2019-01-07 13:53:24 -05:00
obj_err.c Add missing error code when alloc-return-null 2018-04-26 12:27:46 -04:00
obj_lcl.h
obj_lib.c Reorganize private crypto header files 2019-09-27 23:57:58 +02:00
obj_mac.num Add OIDs for HMAC SHA512/224 and HMAC SHA512/256. 2018-08-01 11:58:39 +10:00
obj_xref.c Harmonize use of sk_TYPE_find's return value. 2018-08-07 08:56:54 +02:00
obj_xref.h make update 2019-01-03 09:26:34 +00:00
obj_xref.txt Integrate X448 and Ed448 into libcrypto 2018-03-02 10:14:31 +00:00
objects.pl Update generator copyright year. 2019-01-07 13:53:24 -05:00
objects.txt Fix GOST OID 2019-05-24 12:36:06 +03:00
objxref.pl Update generator copyright year. 2019-01-07 13:53:24 -05:00
README Many spelling fixes/typo's corrected. 2017-11-11 19:03:10 -05:00

objects.txt syntax
------------------

To cover all the naming hacks that were previously in objects.h needed some
kind of hacks in objects.txt.

The basic syntax for adding an object is as follows:

	1 2 3 4		: shortName	: Long Name

		If Long Name contains only word characters and hyphen-minus
		(0x2D) or full stop (0x2E) then Long Name is used as basis
		for the base name in C. Otherwise, the shortName is used.

		The base name (let's call it 'base') will then be used to
		create the C macros SN_base, LN_base, NID_base and OBJ_base.

		Note that if the base name contains spaces, dashes or periods,
		those will be converted to underscore.

Then there are some extra commands:

	!Alias foo 1 2 3 4

		This just makes a name foo for an OID.  The C macro
		OBJ_foo will be created as a result.

	!Cname foo

		This makes sure that the name foo will be used as base name
		in C.

	!module foo
	1 2 3 4		: shortName	: Long Name
	!global

		The !module command was meant to define a kind of modularity.
		What it does is to make sure the module name is prepended
		to the base name.  !global turns this off.  This construction
		is not recursive.

Lines starting with # are treated as comments, as well as any line starting
with ! and not matching the commands above.