akka/akka-http

Provide documentation about how to configure TLS for the client and server side

Open

#237 opened on Sep 12, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docs

Description

Issue by jrudolph Tuesday Feb 10, 2015 at 15:39 GMT Originally opened as https://github.com/akka/akka/issues/16829

In spray we had only very sparse documentation about this topic and referred to the general SSL configuration of Java. It may make sense to provide proper documentation about this topic or at least provide working examples showing how to configure SSL in the most common situations.

  • configure server certificates
  • configure certain ciphers on the server and client side
  • add a custom CA certificate to the client side
  • disable certificate checking for testing purposes

/cc @sirthias

Also see spray/spray#721.

Contributor guide

Tech stack
scalajava
Domain
securitybackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of SSL/TLSFamiliarity with akka http
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests documentation for TLS configuration in akka http. Research should start by examining the referenced spray/spray#721 issue for context, and then explore the current akka http documentation for any existing TLS examples. The documentation should cover configuring server certificates, setting ciphers, adding custom CA certificate, and disabling certificate checking for testing. Also check if there are any open PRs related to this issue and consult the akka http source code for SSL configuration classes.