starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 22:03:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add custom CA Certificate #9973

New Issue
Closed
opened 2025-12-29 21:25:06 +01:00 by adam · 7 comments
adam commented 2025-12-29 21:25:06 +01:00
Owner
Copy Link

Originally created by @chaeynz on GitHub (Jul 11, 2024).

NetBox version

v4.0.2

Feature type

New functionality

Proposed functionality

As a user, I would like to add custom CA certificates to Netbox, so that outgoing Webhooks will not fail, if the HTTP Server serves a self-signed (self-signed CA) certificate.

Use case

Currently I just cat my.crt >> netbox/venv/python*.*/certifi/cacert.pem
The venv does not persist after an upgrade, so I have to do this after every update.
It would be convenient to have a custom cert storage that persists.

Database changes

No response

External dependencies

No response

Originally created by @chaeynz on GitHub (Jul 11, 2024). ### NetBox version v4.0.2 ### Feature type New functionality ### Proposed functionality As a user, I would like to add custom CA certificates to Netbox, so that outgoing Webhooks will not fail, if the HTTP Server serves a self-signed (self-signed CA) certificate. ### Use case Currently I just `cat my.crt >> netbox/venv/python*.*/certifi/cacert.pem` The venv does not persist after an upgrade, so I have to do this after every update. It would be convenient to have a custom cert storage that persists. ### Database changes _No response_ ### External dependencies _No response_
adam added the type: featurenetbox labels 2025-12-29 21:25:06 +01:00
adam closed this issue 2025-12-29 21:25:07 +01:00
adam commented 2025-12-29 21:25:08 +01:00
Author
Owner
Copy Link

@Vivida1 commented on GitHub (Jul 18, 2024):

What seems to work if you use Ubuntu (24.04) and docker-compose:

Install the CA into the OS:

vim /usr/local/share/ca-certificates/my-root-ca.crt
update-ca-certificates

Mount the bundle into the container and tell Python requests via env to use the bundle:

  netbox:
    image: docker.io/netboxcommunity/netbox:v4.0-2.9.1
    volumes:
    - /etc/ssl:/etc/ssl:ro
   # [...]
    environment:
      REQUESTS_CA_BUNDLE: "/etc/ssl/certs/ca-certificates.crt"
@Vivida1 commented on GitHub (Jul 18, 2024): What seems to work if you use Ubuntu (24.04) and docker-compose: Install the CA into the OS: ``` bash vim /usr/local/share/ca-certificates/my-root-ca.crt update-ca-certificates ``` Mount the bundle into the container and tell Python requests via env to use the bundle: ``` yaml netbox: image: docker.io/netboxcommunity/netbox:v4.0-2.9.1 volumes: - /etc/ssl:/etc/ssl:ro # [...] environment: REQUESTS_CA_BUNDLE: "/etc/ssl/certs/ca-certificates.crt" ```
adam commented 2025-12-29 21:25:08 +01:00
Author
Owner
Copy Link

@m2martin commented on GitHub (Jul 25, 2024):

What is the preferrable way to accomplish this in your opinion (from a user's perspective)?

Make it part of the upgrade.sh install/upgrade process? So, providing x509 certificates at a certain location, which will patch Certifi's cert store when running upgrade.sh?

Seems to be the only way of doing this as Certifi itself does not provide a way to do this programatically.

But this may also be a security risk because a fake trust may be implemented into the environment without further notice. So, I'd opt for user confirmation or sth. like that. This would make the process semi-automated.

EDIT:
Maybe it is a way better idea to pass environment vars using systemd, so requests could handle them. This would not require any change for the Netbox project or any fancy unsupported or risky patches for Certifi.

@m2martin commented on GitHub (Jul 25, 2024): What is the preferrable way to accomplish this in your opinion (from a user's perspective)? Make it part of the `upgrade.sh` install/upgrade process? So, providing x509 certificates at a certain location, which will patch Certifi's cert store when running `upgrade.sh`? Seems to be the only way of doing this as Certifi itself does not provide a way to do this programatically. But this may also be a security risk because a _fake trust_ may be implemented into the environment without further notice. So, I'd opt for user confirmation or sth. like that. This would make the process semi-automated. EDIT: Maybe it is a way better idea to pass environment vars using systemd, so requests could handle them. This would not require any change for the Netbox project or any fancy unsupported or risky patches for Certifi.
adam commented 2025-12-29 21:25:08 +01:00
Author
Owner
Copy Link

@Vivida1 commented on GitHub (Jul 25, 2024):

Interestingly enough, Certifi says it does not support modifying the trust store:

Addition/Removal of Certificates

Certifi does not support any addition/removal or other modification of the CA trust store content. This project is intended to provide a reliable and highly portable root of trust to python deployments. Look to upstream projects for methods to use alternate trust.

I would just give the user the option to define a custom CA trust store. If you don't want any changes to the netbox project, maybe documenting setting REQUESTS_CA_BUNDLE would already help a lot.

@Vivida1 commented on GitHub (Jul 25, 2024): Interestingly enough, Certifi says it does not support modifying the trust store: > Addition/Removal of Certificates > > Certifi does not support any addition/removal or other modification of the CA trust store content. This project is intended to provide a reliable and highly portable root of trust to python deployments. Look to upstream projects for methods to use alternate trust. I would just give the user the option to define a custom CA trust store. If you don't want any changes to the netbox project, maybe documenting setting `REQUESTS_CA_BUNDLE` would already help a lot.
adam commented 2025-12-29 21:25:08 +01:00
Author
Owner
Copy Link

@chaeynz commented on GitHub (Jul 26, 2024):

What is the preferrable way to accomplish this in your opinion (from a user's perspective)?

My first thought was adding this through the Settings of Netbox, maybe storing the certs in the PostgreSQL, maybe that is overkill?

What do you think about a directory instead, where each time upgrade.sh runs it will cat each cert in that dir and append it to the certifi cacert.pem ?

We're not using Docker, so I'm not sure if the Environment variable helps

@chaeynz commented on GitHub (Jul 26, 2024): > What is the preferrable way to accomplish this in your opinion (from a user's perspective)? My first thought was adding this through the Settings of Netbox, maybe storing the certs in the PostgreSQL, maybe that is overkill? What do you think about a directory instead, where each time upgrade.sh runs it will `cat` each cert in that dir and append it to the certifi cacert.pem ? We're not using Docker, so I'm not sure if the Environment variable helps
adam commented 2025-12-29 21:25:09 +01:00
Author
Owner
Copy Link

@m2martin commented on GitHub (Aug 5, 2024):

Two approaches should already be possible:

@m2martin commented on GitHub (Aug 5, 2024): Two approaches should already be possible: - Environment vars can be passed using the systemd unit file (or Docker, if used) - Additionally, you can set a CA file per webhook (https://netboxlabs.com/docs/netbox/en/stable/models/extras/webhook/#ca-file-path)
adam commented 2025-12-29 21:25:09 +01:00
Author
Owner
Copy Link

@chaeynz commented on GitHub (Nov 8, 2024):

(Just want to state this again, to clarify) I'm not using docker. This is the default installation on a VM as described in https://netboxlabs.com/docs/netbox/en/stable/installation/

@chaeynz commented on GitHub (Nov 8, 2024): (Just want to state this again, to clarify) I'm not using docker. This is the default installation on a VM as described in https://netboxlabs.com/docs/netbox/en/stable/installation/
adam commented 2025-12-29 21:25:09 +01:00
Author
Owner
Copy Link

@chaeynz commented on GitHub (Nov 8, 2024):

image

I see the CA file per webhook here.
Not sure if this was released recently, but this definetely solves my issue. ( Was I just blind?? :o )
Thanks!

Closing this issue

@chaeynz commented on GitHub (Nov 8, 2024): ![image](https://github.com/user-attachments/assets/3761632b-a19f-46b5-a485-a6988bac64f9) I see the CA file per webhook here. Not sure if this was released recently, but this definetely solves my issue. ( Was I just blind?? :o ) Thanks! Closing this issue
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label netbox type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9973
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?