.. Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed
   with this work for additional information regarding copyright
   ownership.  The ASF licenses this file to you 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.

.. include:: /common.defs
.. default-domain:: cpp

TSSslClientCertUpdate
*********************

Traffic Server TLS client cert update

Synopsis
========

.. code-block:: cpp

    #include <ts/ts.h>

.. function:: TSReturnCode TSSslClientCertUpdate(const char *cert_path, const char *key_path)

Description
===========

:func:`TSSslClientCertUpdate` updates existing client certificates configured in :file:`sni.yaml` or
`proxy.config.ssl.client.cert.filename`. :arg:`cert_path` must match the resolved certificate path used by
Traffic Server. Relative certificate names in the configuration are resolved against
`proxy.config.ssl.client.cert.path`. :func:`TSSslClientCertUpdate` returns :enumerator:`TS_SUCCESS` only if
:arg:`cert_path` exists in the configuration and is reloaded into every matching context.

Any certificate data cached for :arg:`cert_path` and :arg:`key_path` is discarded as well, so client
contexts that Traffic Server creates after the update also use the new certificate rather than the
previously cached one.