From 239296da4d2d17929d7b5285b749cdeef3e44ad6 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Tue, 12 Jul 2022 13:39:09 +0200 Subject: Convert all source/*.html to .md Partial fix of #324 Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/web/pull/349) --- .gitignore | 1 + Makefile | 11 +++++- source/dirdata.yaml | 12 ++++++ source/gitrepo.html | 76 ------------------------------------- source/gitrepo.md | 44 ++++++++++++++++++++++ source/index.html | 104 --------------------------------------------------- source/index.md | 68 +++++++++++++++++++++++++++++++++ source/license.html | 53 -------------------------- source/license.md | 20 ++++++++++ source/mirror.html | 55 --------------------------- source/mirror.md | 23 ++++++++++++ source/sidebar.shtml | 28 -------------- 12 files changed, 178 insertions(+), 317 deletions(-) create mode 100644 source/dirdata.yaml delete mode 100644 source/gitrepo.html create mode 100644 source/gitrepo.md delete mode 100644 source/index.html create mode 100644 source/index.md delete mode 100644 source/license.html create mode 100644 source/license.md delete mode 100644 source/mirror.html create mode 100644 source/mirror.md delete mode 100644 source/sidebar.shtml diff --git a/.gitignore b/.gitignore index ee6db23..71ab83a 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,7 @@ policies/technical/*.html policies/technical/*.inc source/*.gz* source/*.patch +source/*.html source/.htaccess source/index.inc source/old/*/ diff --git a/Makefile b/Makefile index 10cdac8..c5fd4c3 100644 --- a/Makefile +++ b/Makefile @@ -72,6 +72,14 @@ H_POLICIES = $(addsuffix .html,\ $(basename $(shell git ls-files -- policies/*.md \ policies/general/*.md \ policies/technical/*.md))) +# We filter out any file starting with 'sub-'... they get special treatment +H_SOURCE= $(addsuffix .html,\ + $(basename $(shell git ls-files -- source/*.md \ + source/old/*.md \ + | grep -v '/sub-') \ + $(basename $(shell git ls-files -- source/*.md.tt \ + source/old/*.md.tt \ + | grep -v '/sub-')))) H_SUPPORT = $(addsuffix .html,$(basename $(shell git ls-files -- support/*.md))) SIMPLE = $(H_TOP) \ @@ -92,9 +100,9 @@ SIMPLE = $(H_TOP) \ $(foreach S,$(SERIES) $(OLDSERIES),news/vulnerabilities-$(S).html) \ $(H_POLICIES) \ policies/glossary.html \ + $(H_SOURCE) \ source/.htaccess \ source/index.inc \ - source/old/index.html \ $(H_SUPPORT) SRCLISTS = $(foreach S,$(FUTURESERIES) $(SERIES) $(OLDSERIES2) fips,source/old/$(S)/index.inc source/old/$(S)/index.html) @@ -561,5 +569,6 @@ $(foreach H, \ $(filter %.html,$(MANPAGES_TARGETS)) \ $(H_NEWS) \ $(H_POLICIES) \ + $(H_SOURCE) \ $(H_SUPPORT) \ ,$(eval $(call makehtmldepend,$(H)))) diff --git a/source/dirdata.yaml b/source/dirdata.yaml new file mode 100644 index 0000000..4b83803 --- /dev/null +++ b/source/dirdata.yaml @@ -0,0 +1,12 @@ +--- +breadcrumbs: | + [Home](/) : [Downloads](.) +sidebar: | + # [Downloads](.) + + - [Git Repository](gitrepo.html) + - [License](license.html) + - [OCB License](OCB-patent-grant-OpenSSL.pdf) + - [Old Releases](old/) + - [Mirror Sites](mirror.html) +--- diff --git a/source/gitrepo.html b/source/gitrepo.html deleted file mode 100644 index c097edf..0000000 --- a/source/gitrepo.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - -
-
-
-
-

Git Repository

- -
-

The OpenSSL software is developed using a Git repository. - Read-only access to the repository is available at - git.openssl.org. We also maintain a downstream clone on GitHub, at - https://github.com/openssl/openssl - on GitHub. This repository is updated with every commit and is - accessible through a number of protocols.

- -

On the OpenSSL repository we only support the git - protocol. Use the following command to clone the git repository - including all available branches and tags: - 

-
-$ git clone git://git.openssl.org/openssl.git
-
-

- -

Access to specific branches is possible via the standard branch - and checkout commands. See the discussion of branch naming below for - more information.

- -

On Windows, once the repository is cloned, you should ensure - that line endings are set correctly:

- - 
-
-$ cd openssl
-$ git config core.autocrlf false
-$ git config core.eol lf
-$ git checkout .
-
- -

Git branch names and tagging

- -

The master branch, also known as the development branch, - contains the latest bleeding edge code. There are also several - stable branches where stable releases come from. These take - the form OpenSSL_x_y_z-stable so, for example, the 1.1.0 stable - branch is OpenSSL_1_1_0-stable. When an actual release is - made it is tagged in the form OpenSSL_x_y_zp or a beta - OpenSSL_x_y_xp-betan, though you should normally just download - the release tarball. Tags and branches are occasionally used for other - purposes such as testing experimental or unstable code before it is - merged into another branch.

- -
- -
-
- -
-
- - - - - diff --git a/source/gitrepo.md b/source/gitrepo.md new file mode 100644 index 0000000..f91afc3 --- /dev/null +++ b/source/gitrepo.md @@ -0,0 +1,44 @@ +--- +breadcrumb: Git Repository +--- +# Git Repository + +The OpenSSL software is developed using a Git repository. Read-only access +to the repository is available at git.openssl.org. We also maintain a +downstream clone on GitHub, at on +GitHub. This repository is updated with every commit and is accessible +through a number of protocols. + +On the OpenSSL repository we only support the *git* protocol. Use the +following command to clone the git repository including all available +branches and tags: + +``` console +$ git clone git://git.openssl.org/openssl.git +``` + +Access to specific branches is possible via the standard branch and +checkout commands. See the discussion of branch naming below for more +information. + +On Windows, once the repository is cloned, you should ensure that line +endings are set correctly: + +``` console +$ cd openssl +$ git config core.autocrlf false +$ git config core.eol lf +$ git checkout . +``` + +## Git branch names and tagging + +The *master* branch, also known as the development branch, contains the +latest bleeding edge code. There are also several *stable* branches +where stable releases come from. These take the form +*OpenSSL\_x\_y\_z-stable* so, for example, the 1.1.0 stable branch is +*OpenSSL\_1\_1\_0-stable*. When an actual release is made it is tagged +in the form *OpenSSL\_x\_y\_zp* or a beta *OpenSSL\_x\_y\_xp-betan*, +though you should normally just download the release tarball. Tags and +branches are occasionally used for other purposes such as testing +experimental or unstable code before it is merged into another branch. diff --git a/source/index.html b/source/index.html deleted file mode 100644 index d2964c6..0000000 --- a/source/index.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - -
-
-
-
-

Downloads

-
-

The master sources are maintained in our - git repository, which is - accessible over the network and cloned on GitHub, - at https://github.com/openssl/openssl. - Bugs and pull patches (issues and pull requests) should be - filed on the GitHub repo. - Please familiarize yourself with the - license. -

- -

The table below lists the latest releases for every branch. - (For an explanation of the numbering, see our - release strategy.) - All releases can be found at - /source/old. - A list of mirror sites can be found here. -

- -

Note: The latest stable version is the 3.0 series supported - until 7th September 2026. This is also a Long Term Support (LTS) version. - The previous LTS version (the 1.1.1 series) is also available and is - supported until 11th September 2023. All older versions (including 1.1.0, - 1.0.2, 1.0.0 and 0.9.8) are now out of support and should not be used. - Users of these older versions are encouraged to upgrade to 3.0 as soon - as possible. Extended support for 1.0.2 to gain access to security fixes - for that version is available.

- -

OpenSSL 3.0 is the latest major version of OpenSSL. The OpenSSL FIPS - Object Module (FOM) 3.0 is an integrated part of the OpenSSL 3.0 - download. You do not need to download the 3.0 FOM separately. Refer to - the installation instructions inside the download, and use the - "enable-fips" compile time configuration option to build it.

- -

For an overview of some of the key concepts in OpenSSL 3.0 see the - libcrypto - manual page. - Information and notes about migrating existing applications to OpenSSL - 3.0 are available in the - OpenSSL 3.0 Migration Guide

- - - - - - - - -
KBytes Date  File 
-

 

- -

When building a release for the first time, please make sure - to look at the INSTALL file in the distribution along with any NOTES - file applicable to your platform. If you have problems, look at the FAQ, - which can be found online. If you - still need more help, then join the - openssl-users email list and - post a question there.

- -

PGP keys for the signatures are available from the - OTC page. - Current members that sign releases include Richard Levitte, - Matt Caswell, Paul Dale, and Tomas Mraz.

- -

- Each day we make a snapshot of each development branch. - They can be found at - https://www.openssl.org/source/snapshot/. - These daily snapshots of the source tree are provided for - convenience only and not even guaranteed to compile. Note that - keeping a git local repository and updating it every 24 hours - is equivalent and will often be faster and more efficient.

- - -
- - -
-
- -
-
- - - - - diff --git a/source/index.md b/source/index.md new file mode 100644 index 0000000..5ba334c --- /dev/null +++ b/source/index.md @@ -0,0 +1,68 @@ +--- +breadcrumb: Downloads +--- +# Downloads + +The master sources are maintained in our [git repository](gitrepo.html), +which is accessible over the network and cloned on GitHub, at +. Bugs and pull patches (issues and +pull requests) should be filed on the GitHub repo. Please familiarize +yourself with the [license](license.html). + +The table below lists the latest releases for every branch. (For an explanation +of the numbering, see our [release strategy](/policies/releasestrat.html).) +All releases can be found at [/source/old](old). A list of mirror sites can be +found [here](mirror.html). + +*Note:* The latest stable version is the 3.0 series supported until 7th +September 2026. This is also a Long Term Support (LTS) version. The +previous LTS version (the 1.1.1 series) is also available and is +supported until 11th September 2023. All older versions (including +1.1.0, 1.0.2, 1.0.0 and 0.9.8) are now out of support and should not be +used. Users of these older versions are encouraged to upgrade to 3.0 as +soon as possible. Extended support for 1.0.2 to gain access to security +fixes for that version is [available](/support/contracts.html). + +OpenSSL 3.0 is the latest major version of OpenSSL. The OpenSSL FIPS +Object Module (FOM) 3.0 is an integrated part of the OpenSSL 3.0 +download. You do not need to download the 3.0 FOM separately. Refer to +the installation instructions inside the download, and use the +"enable-fips" compile time configuration option to build it. + +For an overview of some of the key concepts in OpenSSL 3.0 see the +libcrypto [manual +page](https://www.openssl.org/docs/man3.0/man7/crypto.html). Information +and notes about migrating existing applications to OpenSSL 3.0 are +available in the [OpenSSL 3.0 Migration +Guide](https://www.openssl.org/docs/man3.0/man7/migration_guide.html) + +

+ + + + + + + +
KBytes Date  File 
+

+ +When building a release for the first time, please make sure to look at +the INSTALL file in the distribution along with any NOTES file +applicable to your platform. If you have problems, look at the FAQ, +which can be found [online](/docs/faq.html). If you still need more +help, then join the [openssl-users](/community/mailinglists.html) email +list and post a question there. + +PGP keys for the signatures are available from the +[OTC page](https://www.openssl.org/community/otc.html). Current members that +sign releases include Richard Levitte, Matt Caswell, Paul Dale, and Tomas Mraz. + +Each day we make a snapshot of each development branch. They can be +found at . These daily +snapshots of the source tree are provided for convenience only and not +even guaranteed to compile. Note that keeping a git local repository and +updating it every 24 hours is equivalent and will often be faster and +more efficient. + + diff --git a/source/license.html b/source/license.html deleted file mode 100644 index ec6ea5d..0000000 --- a/source/license.html +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - -
-
-
-
-

License

-
-

- OpenSSL is covered by one of two licenses, depending on which - release is involved. In all cases, there is a file named - LICENSE in the top-level of the release. - Copies can also be found here. -

-

- For the 3.0 release, and later releases derived from that, - the Apache License v2 - applies. - This also applies to the git "master" branch. -

-

- For any release made before OpenSSL 3.0 (namely - the 1.1.1, 1.1.0, 1.0.2, and all prior releases including - those not currently supported), - the dual OpenSSL and SSLeay - license - applies. - Note that this is also true for any updates to those - releases -- the "letter suffix" -- no matter when they are made. - It also applies to the git branches for all those - releases, and to any public forks that have not rebased to - master (or 3.0). -

-
- -
-
- -
-
- - - diff --git a/source/license.md b/source/license.md new file mode 100644 index 0000000..ec9a270 --- /dev/null +++ b/source/license.md @@ -0,0 +1,20 @@ +--- +breadcrumb: License +--- +# License + +OpenSSL is covered by one of two licenses, depending on which release is +involved. In all cases, there is a file named `LICENSE` in the top-level +of the release. Copies can also be found here. + +For the 3.0 release, and later releases derived from that, +[the Apache License v2](apache-license-2.0.txt) applies. This also +applies to the git "master" branch. + +For any release made before OpenSSL 3.0 (namely the 1.1.1, 1.1.0, 1.0.2, +and all prior releases including those not currently supported), +[the dual OpenSSL and SSLeay license](license-openssl-ssleay.txt) applies. +Note that this is also true for any updates to those releases -- the +"letter suffix" -- no matter when they are made. It also applies to +the git branches for all those releases, and to any public forks that +have not rebased to master (or 3.0). diff --git a/source/mirror.html b/source/mirror.html deleted file mode 100644 index 96c7386..0000000 --- a/source/mirror.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - -
-
-
-
-

Mirrors

-
-

You can download the latest distribution files from the - following FTP areas:

- - - - - - - - - - - -
LocaleURL
CZftp://ftp.fi.muni.cz/pub/openssl/
DEftp://ftp.pca.dfn.de/pub/tools/net/openssl/
DEhttp://artfiles.org/openssl.org/
HRftp://ftp.linux.hr/pub/openssl/
HUftp://ftp.kfki.hu/pub/packages/security/openssl/
PLftp://guest.kuria.katowice.pl/pub/openssl/
PLrsync://ftp.tpnet.pl/pub/security/openssl/
- -

 

-

We are not interested in adding additional mirrors at the - time.

-
- -
-
- -
-
- - - - - diff --git a/source/mirror.md b/source/mirror.md new file mode 100644 index 0000000..36ce383 --- /dev/null +++ b/source/mirror.md @@ -0,0 +1,23 @@ +--- +breadcrumb: Mirrors +--- +# Mirrors + +You can download the latest distribution files from the following FTP +areas: + +

+ +| Locale | URL | +|--------|----------------------------------------------------| +| CZ | | +| DE | | +| DE | | +| HR | | +| HU | | +| PL | | +| PL | | + +

+ +We are not interested in adding additional mirrors at the time. diff --git a/source/sidebar.shtml b/source/sidebar.shtml deleted file mode 100644 index 6862589..0000000 --- a/source/sidebar.shtml +++ /dev/null @@ -1,28 +0,0 @@ - - - -- cgit v1.2.3