Skip to content

Add audit to new security section #4067

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

Merged
merged 6 commits into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions devops/audit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,8 @@ should be the base URL of the Artifactory instance.

With this, you can now use the provider with the ``conan audit scan`` and ``conan audit list`` commands, by specifying
the provider name with the ``-p``/``--provider`` argument.

.. seealso::

- Please check the :ref:`conan audit command reference <security>` for other security
related features.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Table of contents:
tutorial
CI Tutorial <ci_tutorial/tutorial>
devops/devops
security/security
integrations
examples
reference
Expand Down
41 changes: 41 additions & 0 deletions security/audit.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. _security_audit:

Scanning dependencies with conan audit
======================================

A new command, `conan audit`, was added in **Conan 2.14**. It provides a built-in way to
**scan your dependencies for known CVEs**.

For a step-by-step guide on authentication, usage examples, output formats, and setting up
private providers, see :ref:`Checking package vulnerabilities <devops_audit>`. In short:

1. **Register** at `audit.conan.io <https://audit.conan.io/register>`_
2. **Save your token** and **activate it** via the confirmation email you receive.
3. **Configure Conan to use your token**:

.. code-block:: bash

conan audit provider auth conancenter --token=<token>

4. Run a scan:

.. code-block:: bash

# Check a specific reference
conan audit list zlib/1.2.13

# Scan the entire dependency graph
conan audit scan . # Path to the conanfile.py/txt


This command also supports using your own JFrog Platform as a private provider for
vulnerability scanning. See the :ref:`Adding private providers
<devops_audit_private_providers>` section for more details.

.. seealso::

- For detailed reference documentation on all ``conan audit`` subcommands and their
options, consult the :ref:`conan audit command reference
<reference_commands_audit>`.
- Read more in the dedicated `blog post
<https://blog.conan.io/introducing-conan-audit-command/>`_.
12 changes: 12 additions & 0 deletions security/guidelines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _security_guidelines:


Security guidelines
===================

- Avoid tokens and passwords in URLs, can be in logs
- Users shouldn't have write permissions on the server
- Use write permissions tokens on the server only for very specific jobs
- Enable dependencies checking, with :ref:`conan_audit <security_audit>`
- Own the SWLC of dependencies, and specially binaries: build third parties from ``conan-center-index`` fork
- Backup sources as a mechanism for air-gapped and restricted networks
15 changes: 15 additions & 0 deletions security/sboms.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _security_sboms:


Software Bills of Materials (SBOM)
==================================

Intro...


CycloneDX
---------


Artifactory BuildInfo
---------------------
15 changes: 15 additions & 0 deletions security/security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _security:


Security
========

Security is a critical aspect of many software development projects and products. Conan implements several security features to allow C and C++ developer and organizations to streamline security in their processes.

.. toctree::
:maxdepth: 1

audit
sboms
signing
guidelines
8 changes: 8 additions & 0 deletions security/signing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _security_signing:


Package signing
===============


The package signing plugin description.