GithubHelp home page GithubHelp logo

project's Introduction

Welcome to the OpenSSL Project

openssl logo

github actions ci badge appveyor badge

OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the TLS (formerly SSL), DTLS and QUIC (currently client side only) protocols.

The protocol implementations are based on a full-strength general purpose cryptographic library, which can also be used stand-alone. Also included is a cryptographic module validated to conform with FIPS standards.

OpenSSL is descended from the SSLeay library developed by Eric A. Young and Tim J. Hudson.

The official Home Page of the OpenSSL Project is www.openssl.org.

Table of Contents

Overview

The OpenSSL toolkit includes:

  • libssl an implementation of all TLS protocol versions up to TLSv1.3 (RFC 8446), DTLS protocol versions up to DTLSv1.2 (RFC 6347) and the QUIC (currently client side only) version 1 protocol (RFC 9000).

  • libcrypto a full-strength general purpose cryptographic library. It constitutes the basis of the TLS implementation, but can also be used independently.

  • openssl the OpenSSL command line tool, a swiss army knife for cryptographic tasks, testing and analyzing. It can be used for

    • creation of key parameters
    • creation of X.509 certificates, CSRs and CRLs
    • calculation of message digests
    • encryption and decryption
    • SSL/TLS/DTLS and client and server tests
    • QUIC client tests
    • handling of S/MIME signed or encrypted mail
    • and more...

Download

For Production Use

Source code tarballs of the official releases can be downloaded from www.openssl.org/source. The OpenSSL project does not distribute the toolkit in binary form.

However, for a large variety of operating systems precompiled versions of the OpenSSL toolkit are available. In particular, on Linux and other Unix operating systems, it is normally recommended to link against the precompiled shared libraries provided by the distributor or vendor.

We also maintain a list of third parties that produce OpenSSL binaries for various Operating Systems (including Windows) on the Binaries page on our wiki.

For Testing and Development

Although testing and development could in theory also be done using the source tarballs, having a local copy of the git repository with the entire project history gives you much more insight into the code base.

The official OpenSSL Git Repository is located at git.openssl.org. There is a GitHub mirror of the repository at github.com/openssl/openssl, which is updated automatically from the former on every commit.

A local copy of the Git Repository can be obtained by cloning it from the original OpenSSL repository using

git clone git://git.openssl.org/openssl.git

or from the GitHub mirror using

git clone https://github.com/openssl/openssl.git

If you intend to contribute to OpenSSL, either to fix bugs or contribute new features, you need to fork the OpenSSL repository openssl/openssl on GitHub and clone your public fork instead.

git clone https://github.com/yourname/openssl.git

This is necessary because all development of OpenSSL nowadays is done via GitHub pull requests. For more details, see Contributing.

Build and Install

After obtaining the Source, have a look at the INSTALL file for detailed instructions about building and installing OpenSSL. For some platforms, the installation instructions are amended by a platform specific document.

Specific notes on upgrading to OpenSSL 3.x from previous versions can be found in the ossl-guide-migration(7ossl) manual page.

Documentation

README Files

There are some README.md files in the top level of the source distribution containing additional information on specific topics.

The OpenSSL Guide

There are some tutorial and introductory pages on some important OpenSSL topics within the OpenSSL Guide.

Manual Pages

The manual pages for the master branch and all current stable releases are available online.

Demos

The are numerous source code demos for using various OpenSSL capabilities in the demos subfolder.

Wiki

There is a Wiki at wiki.openssl.org which is currently not very active. It contains a lot of useful information, not all of which is up-to-date.

License

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.txt file for more details.

Support

There are various ways to get in touch. The correct channel depends on your requirement. See the SUPPORT file for more details.

Contributing

If you are interested and willing to contribute to the OpenSSL project, please take a look at the CONTRIBUTING file.

Legalities

A number of nations restrict the use or export of cryptography. If you are potentially subject to such restrictions, you should seek legal advice before attempting to develop or distribute cryptographic code.

Copyright

Copyright (c) 1998-2024 The OpenSSL Project Authors

Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson

All rights reserved.

project's People

Contributors

arapov avatar nhorman avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

project's Issues

Add information for the automated release user.

We have defined, through the defined PGP key in doc/fingerprints.txt in the source repository, that [email protected] is the user that is going to create the releases.

To allow the commits created with this user, it needs to be established in our databases to be a valid author.

Tasks:

  • Add CLAs for this users, or at the very least, insert it in our CLA db.
  • Make sure that release-tools/publish-release.sh records a human reviewer and runs addrev on the staged commits

Introduction to the OpenSSL Libraries

  • Purpose of libcrypto and libssl
  • Building a simple application using the libraries
  • Introducing some key concepts
  • Initialisation and de-initialisation of the libraries
  • Library contexts
  • Fetching algorithms and property queries
  • Error handling
  • Library conventions
    • get0/get1/set0/set1
    • CLASSNAME_func_name()
  • Multi-threaded applications

some doc is here already: $ man crypto

Analyse and document remaining legacy code dependencies in OpenSSL

There are a number of libcrypto subsystems that still depend on legacy code and aren't well (or at all) prepared for being used with provider implementations. This was a deliberate choice we made in the sprint/summer 2021 to be able to get 3.0.0 out. I recall PKCS#7 and CMS being mentioned at the time, and remember finding the PBE functionality as well (albeit late, so I think I "forgot" to mention it at the time).

There are also a number of openssl app commands that don't quite take providers into account (for example openssl enc -list, which will only display legacy algorithm implementation).

All of these cases need to brought to light... users are starting to notice these discrepancies, see for example openssl/openssl#20221.

The products of this effort should be a list of cases found, with an issue each on github.com attached.

Investigate change in handshakes per second on 2023-06-02

There was a raise on handshake per second metrics for 100 threads but a drop for 500 and 1000 threads after midnight on 2023-06-02 on master branch. See https://graph.openssl.org/d/f6ded4d3-de2c-4279-ba89-21ab98970a96/handshakes-per-second?orgId=1&from=1685397600000&to=1685915999000

There were two commits merged:

openssl/openssl@cee0628

and

openssl/openssl@fc570b2

If the SSL RTT is the culprit for the drop we might want to make the call to ossl_time_now() optional. If the ossl_provider_doall_activated() is the culprit for both the raise and the drop it might be harder to fix but it should still be considered.

Introductory and tutorial material

Create a quickstart and tutorial guide.

@mattcaswell: My proposed structure is a series of 6 man pages as follows. I will focus on pages 3 and 4 initially. 1 should be straight forward. 2, 5, and 6 can come a little later:

Tasks

  1. mattcaswell
  2. mattcaswell
  3. mattcaswell
  4. mattcaswell
  5. QUIC
    mattcaswell
  6. QUIC
    mattcaswell

ddd_demoes update, use of our QUIC API

A "hello world" demo.
Write a demo app that interoperates with another QUIC implementation.

ddd_demoes should be updated.

  • must be moved to demoes directory and up to date
  • check for best practices tls stuff

(we don't refer to any of these demoes from man pages)

Writing a simple blocking TLS Client

  • What is TLS?
    • Confidentiality, Integrity, Authentication
  • What are the different versions of SSL/TLS?
    • SSLv2, SSLv3, TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3
    • Version negotiation
  • Trusted Certificate Store
    • What is a certificate?
    • What is a CA?
    • Getting a certficiate store
  • Important objects for a TLS client application
    • SSL_CTX
    • SSL
    • BIO
  • SSL_SESSION
    • Phases of a TLS connection
  • Set up
    • Handshake
      • Resumption
    • Application data transfer
    • Shutdown
    • Cleanup
  • Sockets and BIOs
  • Hello World TLS client
    • Creating the SSL_CTX and SSL
    • Creating the socket and BIO
    • SNI
    • Verifying the server's certificate
    • Doing the handshake
    • Sending and receiving data
    • Shuting down the connection
    • Final clean up

Writing a simple multi-stream QUIC client

  • Connection and stream objects
    • What is a connection?
    • What is a stream?
    • The SSL object
    • Threading and connection/stream SSL objects
  • The default stream
    • The default stream mode
  • The incoming stream policy
  • Creating a locally initiated stream
  • Accepting remotely initiated streams
  • Using streams for sending/receiving data
    • Restrictions when using streams
  • Concluding a stream
  • Resetting a stream
  • Final clean up
  • Hello World QUIC client with streams

Create About us web page at openssl.org.

Requires input from

QUIC Server Support (R2)

Tasks

  1. 4 of 5
    QUIC QUIC R2 epic
    hlandau
  2. QUIC QUIC R2
    hlandau
  3. QUIC QUIC R2
    hlandau mattcaswell
    nhorman t8m
  4. QUIC QUIC R2
    hlandau mattcaswell
    t8m
  5. QUIC QUIC R2
    hlandau
  6. QUIC QUIC R2
    hlandau
  7. QUIC QUIC R2
    hlandau nhorman
    t8m
  8. QUIC QUIC R2
    hlandau
  9. 3.4.0 Planned eng view QUIC QUIC R2
    hlandau
  10. 3.4.0 Planned eng view QUIC QUIC R2
    hlandau
  11. QUIC QUIC R2
    hlandau
  12. QUIC QUIC R2
  13. 3.4.0 Planned eng view QUIC QUIC R2 good first issue
    Sashan
  14. QUIC QUIC R2
    hlandau
  15. QUIC R2 good first issue
    t8m
  16. QUIC QUIC R2
    hlandau
  17. QUIC QUIC R2 epic good first issue
  18. 1 of 2
    QUIC QUIC R2 good first issue
  19. QUIC QUIC R2 good first issue
  20. QUIC QUIC R2
  21. QUIC QUIC R2
  22. QUIC QUIC R2 good first issue
  23. QUIC QUIC R2 good first issue
  24. QUIC QUIC R2 good first issue
  25. 0 of 4
    QUIC QUIC R2 epic triaged: feature
  26. QUIC QUIC R2 epic
  27. 1 of 2
    QUIC QUIC R2 good first issue

Create a proposal for offering binaries

  • Definitely Windows
  • We might consider offering other platforms in future but Windows serves as a good MVP
  • Proposal to serve as basis for further discussio

Write a proposal for security policy updates, esp. for Low CVEs

  • Low CVEs: should we still make low CVEs public?
  • Proposal: 'When we announce a low CVE, there must be a release with a scheduled date [possibly required to be within 4 weeks].'
  • Release date should be mentioned in advisory text
  • Date should be 'on or before'. We commit to the date.

Presentations/Talk

Writing a simple blocking QUIC Client

  • What is QUIC?
  • Understanding how TLS is used in QUIC
  • UDP and BIOs
    • BIO_s_dgram()
  • QUIC time based events
    • SSL_handle_events()
    • SSL_get_event_timeout()
    • Thread assisted mode
  • ALPN
  • QUIC shutdown
  • Hello World QUIC client
    • Differences between the Hello World TLS client and the QUIC client

Automatic release staging - Make buildbot behave

Code was added to our buildbots (ci.buildbot.openssl.org) to deploy release staging. Unfortunately, buildbot is unhappy or has surprising behaviors. This needs some extended experimentation and fixing.

Currently observed oddities:

  • The scheduler for release staging specifies codebases that should work, among others staging-tool for the staging tool repo, which should become part of the source stamps to the builds. Alas, it's still absent.

  • The buildbot source step is... somewhat lacking. You're allowed to specify an "origin", thereby specifying a symbolic remote. However, subsequent fetches of the same source is done by URL, thereby bypassing the symbolic remote entirely.Our code to check if the source in one repository is the ancestor of the same source from another repository cannot work under these conditions, and needs to be refactored to work differently.

QUIC MVP

Tasks

  1. approval: ready to merge branch: master tests: present triaged: feature
    hlandau
  2. t8m
  3. arapov
  4. t8m
  5. approval: ready to merge branch: master tests: exempted triaged: design triaged: documentation
    t8m
  6. approval: ready to merge branch: master tests: present triaged: feature
    hlandau
  7. paulidale
  8. hlandau
  9. t8m
  10. paulidale
  11. mattcaswell
  12. t8m
  13. QUIC
    paulidale
  14. approval: done branch: master severity: fips change tests: present triaged: feature
    hlandau
  15. triaged: bug
    hlandau
  16. QUIC alpha blocker
    hlandau
  17. QUIC
  18. t8m
  19. 6 of 6
    QUIC
    arapov
  20. QUIC
    t8m
  21. QUIC
    t8m
  22. t8m
  23. QUIC alpha blocker
    hlandau
  24. QUIC
    hlandau
  25. QUIC
    hlandau
  26. QUIC
    hlandau
  27. QUIC
    hlandau
  28. QUIC
  29. QUIC
    hlandau
  30. QUIC
    hlandau
  31. QUIC
    hlandau
  32. QUIC
    hlandau
  33. QUIC
  34. QUIC
  35. QUIC bug
    hlandau mattcaswell
  36. QUIC bug
    hlandau
  37. QUIC
    paulidale
  38. QUIC
    hlandau
  39. QUIC bug
    mattcaswell
  40. QUIC
    mattcaswell
  41. QUIC
    mattcaswell
  42. QUIC
    mattcaswell
  43. QUIC
    t8m
  44. QUIC
    t8m
  45. QUIC
    mattcaswell
  46. QUIC
    hlandau
  47. branch: 3.2 branch: master severity: regression triaged: bug
    jamuir
  48. QUIC
    t8m
  49. QUIC
    hlandau
  50. QUIC
    hlandau
  51. branch: master triaged: bug
    nhorman
  52. QUIC
    mattcaswell
  53. t8m
  54. approval: ready to merge branch: 3.1 branch: master severity: fips change tests: exempted triaged: bug
    t8m
  55. approval: ready to merge branch: master tests: present triaged: bug
    mattcaswell
  56. levitte mattcaswell
    t8m
  57. approval: ready to merge branch: master tests: present triaged: bug
    hlandau
  58. approval: ready to merge branch: master tests: present triaged: feature
    hlandau
  59. branch: master triaged: bug
    t8m
  60. branch: 3.2 branch: master triaged: bug
    hlandau
  61. QUIC
  62. QUIC
    mattcaswell
  63. QUIC
    nhorman
  64. approval: ready to merge branch: 3.2 branch: master tests: present triaged: bug
    hlandau
  65. QUIC
    hlandau mattcaswell

Cleanse the released data in rstream code

If SSL_OP_CLEANSE_PLAINTEXT is set we need to cleanse the decrypted data - one place where this needs to be done is in rstream code. Other is the release of a decrypted packet.

Writing a simple non-blocking client for TLS/QUIC

  • Advantages of using non-blocking
  • Non-blocking sockets vs non-blocking at the SSL API level
    • Setting a socket for non-blocking
    • SSL_set_blocking_mode()
  • Checking the socket for readability/writability
  • SSL_ERROR_WANT_READ and SSL_ERROR_WANT_WRITE
  • SSL_net_read_desired() and SSL_net_write_desired()
  • Non-blocking Hello World TLS client
  • Non-blocking Hello World QUIC client

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.