Skip to content

Latest commit

 

History

History
110 lines (81 loc) · 4.05 KB

File metadata and controls

110 lines (81 loc) · 4.05 KB

WebService - Client Certificate Authentication

Beta License: AGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

Adds support for Client Side Certificates to the webservice module.

Table of contents

Certificate paths are configured via server_environment. Add the configuration section matching your backend's tech_name to your server environment files:

[webservice_backend.webservice_client_certificate_auth]
auth_type = client_certificate
client_certificate_path = /path/to/client.cert
# Optional: Leave empty if the private key is bundled in the certificate file
client_private_key_path = /path/to/client.key

When a call is made using the backend, the adapter automatically injects the cert parameter into the underlying Python requests call based on the provided configuration:

  • Certificate only: Passed as cert='/path/to/file' (a single file containing the private key and the certificate).
  • Certificate and Key: Passed as a tuple cert=('/path/to/crt', '/path/to/key').

Warning: the private key to your local certificate must be unencrypted. Currently, requests does not support using encrypted keys.

See Requests: Client Side Certificates for underlying implementation details.

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

  • Camptocamp

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/web-api project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.