Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature - Traffic Ops Client Certificate Authentication #7110

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
25 changes: 25 additions & 0 deletions docs/source/admin/quick_howto/client_cert_auth.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
..
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
.. http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..

.. _client-cert-auth:

**************************************
Client Certificates for Authentication
**************************************

An alternative mechanism for providing credentials and authenticating access.

There are multiple mechanisms, specifically within Traffic Ops, that provide a means for authentication.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... what are they, though?

7 changes: 6 additions & 1 deletion docs/source/admin/traffic_ops.rst
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,12 @@ This file deals with the configuration parameters of running Traffic Ops itself.
:renew_days_before_expiration: Set the number of days before expiration date to renew certificates.
:summary_email: The email address to use for summarizing certificate expiration and renewal status. If it is blank, no email will be sent.

:client_certificate_authentication: This is an optional section of configurations client provided certificate based authentication. However, if ``"ClientAuth" : "1"``` is enabled in the ``tls_config`` section in ``traffic_ops_golang``, then this field is required.

.. versionadded:: 7.0

:root_certificates_directory: A string representing the absolute path of the directory where Root CA certificates are located. These Root CA certificates are used for verifying the certificate provided by the client.

:default_certificate_info: This is an optional object to define default values when generating a self signed certificate when an HTTPS delivery service is created or updated. If this is an empty object or not present in the :ref:`cdn.conf` then the term "Placeholder" will be used for all fields.

:business_unit: An optional field which, if present, will represent the business unit for which the SSL certificate was generated
Expand Down Expand Up @@ -517,7 +523,6 @@ This file deals with the configuration parameters of running Traffic Ops itself.

.. versionadded:: 7.0


Example cdn.conf
''''''''''''''''
.. include:: ../../../traffic_ops/app/conf/cdn.conf
Expand Down
1 change: 0 additions & 1 deletion traffic_ops/app/conf/production/database.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

{
"description": "Local PostgreSQL database on port 5432",
"dbname": "traffic_ops",
Expand Down