Browse Source

Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt

Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12109)
master
Dr. David von Oheimb 1 year ago
parent
commit
036cbb6bbf
47 changed files with 313 additions and 107 deletions
  1. +18
    -10
      CHANGES.md
  2. +1
    -1
      CONTRIBUTING.md
  3. +1
    -1
      Configurations/15-android.conf
  4. +0
    -0
      Configurations/README-design.md
  5. +0
    -0
      Configurations/README.md
  6. +3
    -3
      Configure
  7. +0
    -0
      HACKING.md
  8. +19
    -15
      INSTALL.md
  9. +0
    -0
      LICENSE.txt
  10. +1
    -1
      NEWS.md
  11. +0
    -0
      NOTES-Android.md
  12. +0
    -0
      NOTES-DJGPP.md
  13. +0
    -0
      NOTES-Perl.md
  14. +0
    -0
      NOTES-Unix.md
  15. +0
    -0
      NOTES-VMS.md
  16. +0
    -0
      NOTES-Valgrind.md
  17. +0
    -0
      NOTES-Windows.txt
  18. +0
    -0
      README-Engine.md
  19. +0
    -0
      README-FIPS.md
  20. +1
    -1
      README.md
  21. +0
    -0
      VERSION.dat
  22. +7
    -0
      VERSION.txt
  23. +1
    -1
      config.com
  24. +0
    -0
      crypto/README-sparse_array.md
  25. +0
    -0
      crypto/engine/README.md
  26. +0
    -0
      crypto/err/README.md
  27. +0
    -0
      crypto/objects/README.md
  28. +0
    -0
      crypto/perlasm/README.md
  29. +0
    -0
      crypto/property/README.md
  30. +1
    -1
      demos/README.txt
  31. +0
    -1
      demos/bio/README.txt
  32. +0
    -3
      demos/certs/README.txt
  33. +0
    -0
      dev/README.md
  34. +2
    -2
      dev/release-aux/release-version-fn.sh
  35. +1
    -1
      dev/release.sh
  36. +1
    -1
      doc/README.md
  37. +0
    -0
      ssl/record/README.md
  38. +0
    -0
      ssl/statem/README.md
  39. +57
    -58
      test/README-dev.md
  40. +0
    -0
      test/README-external.md
  41. +2
    -2
      test/README.md
  42. +4
    -0
      test/data.txt
  43. +188
    -0
      test/data2.txt
  44. +0
    -0
      test/recipes/04-test_pem_data/NOTES.txt
  45. +2
    -2
      test/recipes/20-test_dgst.t
  46. +2
    -2
      test/recipes/20-test_pkeyutl.t
  47. +1
    -1
      test/recipes/95-test_external_krb5.t

+ 18
- 10
CHANGES.md View File

@ -173,7 +173,13 @@ OpenSSL 3.0
*Richard Levitte*
* The main project documents (README, NEWS, CHANGES, INSTALL, SUPPORT)
* Project text documents not yet having a proper file name extension
(HACKING, LICENSE, NOTES*, README*, VERSION) have been renamed to *.md
as far as reasonable, else to *.txt, for better use with file managers.
*David von Oheimb*
* The main project documents (README, NEWS, CHANGES, INSTALL, SUPPORT)
have been converted to Markdown with the goal to produce documents
which not only look pretty when viewed online in the browser, but
remain well readable inside a plain text editor.
@ -3104,12 +3110,12 @@ OpenSSL 1.1.0
* State machine rewrite. The state machine code has been significantly
refactored in order to remove much duplication of code and solve issues
with the old code (see ssl/statem/README for further details). This change
does have some associated API changes. Notably the SSL_state() function
has been removed and replaced by SSL_get_state which now returns an
"OSSL_HANDSHAKE_STATE" instead of an int. SSL_set_state() has been removed
altogether. The previous handshake states defined in ssl.h and ssl3.h have
also been removed.
with the old code (see [ssl/statem/README.md](ssl/statem/README.md) for
further details). This change does have some associated API changes.
Notably the SSL_state() function has been removed and replaced by
SSL_get_state which now returns an "OSSL_HANDSHAKE_STATE" instead of an int.
SSL_set_state() has been removed altogether. The previous handshake states
defined in ssl.h and ssl3.h have also been removed.
*Matt Caswell*
@ -11587,7 +11593,8 @@ OpenSSL 0.9.7.]
of specific crypto interfaces. This change also introduces integrated
support for symmetric ciphers and digest implementations - so ENGINEs
can now accelerate these by providing EVP_CIPHER and EVP_MD
implementations of their own. This is detailed in crypto/engine/README
implementations of their own. This is detailed in
[crypto/engine/README.md](crypto/engine/README.md)
as it couldn't be adequately described here. However, there are a few
API changes worth noting - some RSA, DSA, DH, and RAND functions that
were changed in the original introduction of ENGINE code have now
@ -11663,7 +11670,7 @@ OpenSSL 0.9.7.]
makes them more flexible to be built both as statically-linked ENGINEs
and self-contained shared-libraries loadable via the "dynamic" ENGINE.
Also, add stub code to each that makes building them as self-contained
shared-libraries easier (see README.ENGINE).
shared-libraries easier (see [README-Engine.md](README-Engine.md)).
*Geoff Thorpe*
@ -11672,7 +11679,8 @@ OpenSSL 0.9.7.]
self-contained shared-libraries. The "dynamic" ENGINE exposes control
commands that can be used to configure what shared-library to load and
to control aspects of the way it is handled. Also, made an update to
the README.ENGINE file that brings its information up-to-date and
the [README-Engine.md](README-Engine.md) file
that brings its information up-to-date and
provides some information and instructions on the "dynamic" ENGINE
(ie. how to use it, how to build "dynamic"-loadable ENGINEs, etc).


+ 1
- 1
CONTRIBUTING.md View File

@ -64,7 +64,7 @@ guidelines:
5. When at all possible, patches should include tests. These can
either be added to an existing test, or completely new. Please see
test/README for information on the test framework.
test/README.md for information on the test framework.
6. New features or changed functionality must include
documentation. Please look at the "pod" files in doc/man[1357] for


+ 1
- 1
Configurations/15-android.conf View File

@ -1,6 +1,6 @@
#### Android...
#
# See NOTES.ANDROID for details, and don't miss platform-specific
# See NOTES-Android.md for details, and don't miss platform-specific
# comments below...
{


Configurations/README.design → Configurations/README-design.md View File


Configurations/README → Configurations/README.md View File


+ 3
- 3
Configure View File

@ -301,7 +301,7 @@ foreach ( reverse sort( 'aes', 'aria', 'bf', 'camellia', 'cast', 'des', 'dh',
my %version = ();
collect_information(
collect_from_file(catfile($srcdir,'VERSION')),
collect_from_file(catfile($srcdir,'VERSION.dat')),
qr/\s*(\w+)\s*=\s*(.*?)\s*$/ =>
sub {
# Only define it if there is a value at all
@ -314,7 +314,7 @@ collect_information(
}
},
"OTHERWISE" =>
sub { die "Something wrong with this line:\n$_\nin $srcdir/VERSION" },
sub { die "Something wrong with this line:\n$_\nin $srcdir/VERSION.dat" },
);
$config{major} = $version{MAJOR} // 'unknown';
@ -330,7 +330,7 @@ $config{release_date} = $version{RELEASE_DATE} // 'xx XXX xxxx';
$config{version} = "$config{major}.$config{minor}.$config{patch}";
$config{full_version} = "$config{version}$config{prerelease}$config{build_metadata}";
die "erroneous version information in VERSION: ",
die "erroneous version information in VERSION.dat: ",
"$config{version}, $config{shlib_version}\n"
unless (defined $version{MAJOR}
&& defined $version{MINOR}


HACKING → HACKING.md View File


+ 19
- 15
INSTALL.md View File

@ -680,7 +680,8 @@ external test suites are currently supported:
- Python PYCA/Cryptography test suite
- krb5 test suite
See the file [test/README.external](test/README.external) for further details.
See the file [test/README-external.md](test/README-external.md)
for further details.
### no-filenames
@ -1152,8 +1153,8 @@ run:
If your system isn't listed, you will have to create a configuration
file named `Configurations/{{ something }}.conf` and add the correct
configuration for your system. See the available configs as examples
and read [Configurations/README](Configurations/README)
and [Configurations/README.design](Configurations/README.design)
and read [Configurations/README.md](Configurations/README.md) and
[Configurations/README-design.md](Configurations/README-design.md)
for more information.
The generic configurations `cc` or `gcc` should usually work on 32 bit
@ -1223,7 +1224,9 @@ be tested. Run:
**Warning:** you MUST run the tests from an unprivileged account (or disable
your privileges temporarily if your platform allows it).
See the file [test/README.md](test/README.md) for further details.
See [test/README.md](test/README.md) for further details how run tests.
See [test/README-dev.md](test/README-dev.md) for guidelines on adding tests.
Install OpenSSL
---------------
@ -1359,7 +1362,8 @@ over the build process. Typically these should be defined prior to running
Use a different build file name than the platform default
("Makefile" on Unix-like platforms, "makefile" on native Windows,
"descrip.mms" on OpenVMS). This requires that there is a
corresponding build file template. See Configurations/README
corresponding build file template.
See [Configurations/README.md](Configurations/README.md)
for further information.
CC
@ -1382,15 +1386,15 @@ over the build process. Typically these should be defined prior to running
templates for those platforms. The database is comprised of
".conf" files in the Configurations directory. The build
file templates reside there as well as ".tmpl" files. See the
file Configurations/README for further information about the
format of ".conf" files as well as information on the ".tmpl"
files.
file [Configurations/README.md](Configurations/README.md)
for further information about the format of ".conf" files
as well as information on the ".tmpl" files.
In addition to the standard ".conf" and ".tmpl" files, it is
possible to create your own ".conf" and ".tmpl" files and store
them locally, outside the OpenSSL source tree. This environment
variable can be set to the directory where these files are held
and will be considered by Configure before it looks in the
standard directories.
possible to create your own ".conf" and ".tmpl" files and
store them locally, outside the OpenSSL source tree.
This environment variable can be set to the directory where
these files are held and will be considered by Configure
before it looks in the standard directories.
PERL
The name of the Perl executable to use when building OpenSSL.
@ -1534,8 +1538,8 @@ known targets. Using `grep`, you can lookup the target definition in the
The directory contains two README files, which explain the general syntax and
design of the configuration files.
- [Configurations/README](Configurations/README)
- [Configurations/README.design](Configurations/README.design)
- [Configurations/README.md](Configurations/README.md)
- [Configurations/README-design.md](Configurations/README-design.md)
If you need further help, try to search the [openssl-users][] mailing list
or the [GitHub Issues][] for existing solutions. If you don't find anything,


LICENSE → LICENSE.txt View File


+ 1
- 1
NEWS.md View File

@ -1196,7 +1196,7 @@ OpenSSL 0.9.x
* Enhanced EVP interface.
[1] The support for external crypto devices is currently a separate
distribution. See the file README.ENGINE.
distribution. See the file README-Engine.md.
### Major changes between OpenSSL 0.9.5 and OpenSSL 0.9.5a [1 Apr 2000]


NOTES.ANDROID → NOTES-Android.md View File


NOTES.DJGPP → NOTES-DJGPP.md View File


NOTES.PERL → NOTES-Perl.md View File


NOTES.UNIX → NOTES-Unix.md View File


NOTES.VMS → NOTES-VMS.md View File


NOTES.VALGRIND → NOTES-Valgrind.md View File


NOTES.WIN → NOTES-Windows.txt View File


README.ENGINE → README-Engine.md View File


README.FIPS → README-FIPS.md View File


+ 1
- 1
README.md View File

@ -142,7 +142,7 @@ OpenSSL is licensed under the Apache License 2.0, which means that
you are free to get and use it for commercial and non-commercial
purposes as long as you fulfill its conditions.
See the [LICENSE](LICENSE) file for more details.
See the [LICENSE.txt](LICENSE.txt) file for more details.
Support
=======


VERSION → VERSION.dat View File


+ 7
- 0
VERSION.txt View File

@ -0,0 +1,7 @@
MAJOR=3
MINOR=0
PATCH=0
PRE_RELEASE_TAG=alpha4-dev
BUILD_METADATA=
RELEASE_DATE=""
SHLIB_VERSION=3

+ 1
- 1
config.com View File

@ -42,7 +42,7 @@ Usage: @config [options]
-h This help.
Any other text will be passed to the Configure perl script.
See INSTALL for instructions.
See INSTALL.md for instructions.
$ EOD
$ ENDIF


crypto/README.sparse_array → crypto/README-sparse_array.md View File


crypto/engine/README → crypto/engine/README.md View File


crypto/err/README → crypto/err/README.md View File


crypto/objects/README → crypto/objects/README.md View File


crypto/perlasm/README → crypto/perlasm/README.md View File


crypto/property/README → crypto/property/README.md View File


demos/README → demos/README.txt View File


demos/bio/README → demos/bio/README.txt View File


demos/certs/README → demos/certs/README.txt View File


dev/README → dev/README.md View File


+ 2
- 2
dev/release-aux/release-version-fn.sh View File

@ -36,7 +36,7 @@
# OpenSSL source directory as value.
get_version () {
eval $(git cat-file blob HEAD:VERSION)
eval $(git cat-file blob HEAD:VERSION.dat)
VERSION="$MAJOR.$MINOR.$PATCH"
SERIES="$MAJOR.$MINOR"
TYPE=$( echo "$PRE_RELEASE_TAG" \
@ -102,7 +102,7 @@ set_version () {
PRE_RELEASE_TAG="$PRE_LABEL$PRE_NUM"
;;
esac
cat > "$SOURCEDIR/VERSION" <<EOF
cat > "$SOURCEDIR/VERSION.dat" <<EOF
MAJOR=$MAJOR
MINOR=$MINOR
PATCH=$PATCH


+ 1
- 1
dev/release.sh View File

@ -681,7 +681,7 @@ B<release.sh> recognises both forms.
=head1 VERSION AND STATE
With OpenSSL 3.0, all the version and state information is in the file
F<VERSION>, where the following variables are used and changed:
F<VERSION.dat>, where the following variables are used and changed:
=over 4


doc/README → doc/README.md View File


ssl/record/README → ssl/record/README.md View File


ssl/statem/README → ssl/statem/README.md View File


test/README → test/README-dev.md View File


test/README.external → test/README-external.md View File


+ 2
- 2
test/README.md View File

@ -1,5 +1,5 @@
Test OpenSSL
============
Using OpenSSL Tests
===================
After a successful build, and before installing, the libraries should be tested.
Run:


+ 4
- 0
test/data.txt View File

@ -0,0 +1,4 @@
TEST DATA
Please note that if a test involves a new testing executable,
you will need to do some additions in test/build.info.

+ 188
- 0
test/data2.txt View File

@ -0,0 +1,188 @@
TEST DATA2
Running external test suites with OpenSSL
=========================================
It is possible to integrate external test suites into OpenSSL's "make test".
This capability is considered a developer option and does not work on all
platforms.
The BoringSSL test suite
========================
In order to run the BoringSSL tests with OpenSSL, first checkout the BoringSSL
source code into an appropriate directory. This can be done in two ways:
1) Separately from the OpenSSL checkout using:
$ git clone https://boringssl.googlesource.com/boringssl boringssl
The BoringSSL tests are only confirmed to work at a specific commit in the
BoringSSL repository. Later commits may or may not pass the test suite:
$ cd boringssl
$ git checkout 490469f850e
2) Using the already configured submodule settings in OpenSSL:
$ git submodule update --init
Configure the OpenSSL source code to enable the external tests:
$ cd ../openssl
$ ./config enable-ssl3 enable-ssl3-method enable-weak-ssl-ciphers \
enable-external-tests
Note that using other config options than those given above may cause the tests
to fail.
Run the OpenSSL tests by providing the path to the BoringSSL test runner in the
BORING_RUNNER_DIR environment variable:
$ BORING_RUNNER_DIR=/path/to/boringssl/ssl/test/runner make test
Note that the test suite may change directory while running so the path provided
should be absolute and not relative to the current working directory.
To see more detailed output you can run just the BoringSSL tests with the
verbose option:
$ VERBOSE=1 BORING_RUNNER_DIR=/path/to/boringssl/ssl/test/runner make \
TESTS="test_external_boringssl" test
Test failures and suppressions
------------------------------
A large number of the BoringSSL tests are known to fail. A test could fail
because of many possible reasons. For example:
- A bug in OpenSSL
- Different interpretations of standards
- Assumptions about the way BoringSSL works that do not apply to OpenSSL
- The test uses APIs added to BoringSSL that are not present in OpenSSL
- etc
In order to provide a "clean" baseline run with all the tests passing a config
file has been provided that suppresses the running of tests that are known to
fail. These suppressions are held in the file "test/ossl_shim/ossl_config.json"
within the OpenSSL source code.
The community is encouraged to contribute patches which reduce the number of
suppressions that are currently present.
Python PYCA/Cryptography test suite
===================================
This python test suite runs cryptographic tests with a local OpenSSL build as
the implementation.
First checkout the PYCA/Cryptography module into ./pyca-cryptography using:
$ git submodule update --init
Then configure/build OpenSSL compatible with the python module:
$ ./config shared enable-external-tests
$ make
The tests will run in a python virtual environment which requires virtualenv
to be installed.
$ make test VERBOSE=1 TESTS=test_external_pyca
Test failures and suppressions
------------------------------
Some tests target older (<=1.0.2) versions so will not run. Other tests target
other crypto implementations so are not relevant. Currently no tests fail.
krb5 test suite
===============
Much like the PYCA/Cryptography test suite, this builds and runs the krb5
tests against the local OpenSSL build.
You will need a git checkout of krb5 at the top level:
$ git clone https://github.com/krb5/krb5
krb5's master has to pass this same CI, but a known-good version is
krb5-1.15.1-final if you want to be sure.
$ cd krb5
$ git checkout krb5-1.15.1-final
$ cd ..
OpenSSL must be built with external tests enabled:
$ ./config enable-external-tests
$ make
krb5's tests will then be run as part of the rest of the suite, or can be
explicitly run (with more debugging):
$ VERBOSE=1 make TESTS=test_external_krb5 test
Test-failures suppressions
--------------------------
krb5 will automatically adapt its test suite to account for the configuration
of your system. Certain tests may require more installed packages to run. No
tests are expected to fail.
GOST engine test suite
===============
Much like the PYCA/Cryptography test suite, this builds and runs the GOST engine
tests against the local OpenSSL build.
You will need a git checkout of gost-engine at the top level:
$ git submodule update --init
Then configure/build OpenSSL enabling external tests:
$ ./config shared enable-external-tests
$ make
GOST engine requires CMake for the build process.
GOST engine tests will then be run as part of the rest of the suite, or can be
explicitly run (with more debugging):
$ make test VERBOSE=1 TESTS=test_external_gost_engine
Updating test suites
====================
To update the commit for any of the above test suites:
- Make sure the submodules are cloned locally:
$ git submodule update --init --recursive
- Enter subdirectory and pull from the repository (use a specific branch/tag if required):
$ cd <submodule-dir>
$ git pull origin master
- Go to root directory, there should be a new git status:
$ cd ../
$ git status
...
# modified: <submodule-dir> (new commits)
...
- Add/commit/push the update
git add <submodule-dir>
git commit -m "Updated <submodule> to latest commit"
git push

test/recipes/04-test_pem_data/NOTES → test/recipes/04-test_pem_data/NOTES.txt View File


+ 2
- 2
test/recipes/20-test_dgst.t View File

@ -24,8 +24,8 @@ sub tsignverify {
my $privkey = shift;
my $pubkey = shift;
my $data_to_sign = srctop_file('test', 'README');
my $other_data = srctop_file('test', 'README.external');
my $data_to_sign = srctop_file('test', 'data.txt');
my $other_data = srctop_file('test', 'data2.txt');
my $sigfile = basename($privkey, '.pem') . '.sig';
plan tests => 4;


+ 2
- 2
test/recipes/20-test_pkeyutl.t View File

@ -74,8 +74,8 @@ sub tsignverify {
my $pubkey = shift;
my @extraopts = @_;
my $data_to_sign = srctop_file('test', 'README');
my $other_data = srctop_file('test', 'README.external');
my $data_to_sign = srctop_file('test', 'data.txt');
my $other_data = srctop_file('test', 'data2.txt');
my $sigfile = basename($privkey, '.pem') . '.sig';
my @args = ();


+ 1
- 1
test/recipes/95-test_external_krb5.t View File

@ -17,7 +17,7 @@ setup("test_external_krb5");
plan skip_all => "No external tests in this configuration"
if disabled("external-tests");
plan skip_all => "krb5 not available"
if ! -f srctop_file("krb5", "README");
if ! -f srctop_file("krb5", "data.txt");
plan tests => 1;


Loading…
Cancel
Save