cyclonedx.model.component_evidence
==================================

.. py:module:: cyclonedx.model.component_evidence


Classes
-------

.. autoapisummary::

   cyclonedx.model.component_evidence.IdentityField
   cyclonedx.model.component_evidence.AnalysisTechnique
   cyclonedx.model.component_evidence.Method
   cyclonedx.model.component_evidence.Identity
   cyclonedx.model.component_evidence.Occurrence
   cyclonedx.model.component_evidence.CallStackFrame
   cyclonedx.model.component_evidence.CallStack
   cyclonedx.model.component_evidence.ComponentEvidence


Module Contents
---------------

.. py:class:: IdentityField

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enum object that defines the permissible field types for Identity.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_identity


   .. py:attribute:: GROUP
      :value: 'group'



   .. py:attribute:: NAME
      :value: 'name'



   .. py:attribute:: VERSION
      :value: 'version'



   .. py:attribute:: PURL
      :value: 'purl'



   .. py:attribute:: CPE
      :value: 'cpe'



   .. py:attribute:: OMNIBOR_ID
      :value: 'omniborId'



   .. py:attribute:: SWHID
      :value: 'swhid'



   .. py:attribute:: SWID
      :value: 'swid'



   .. py:attribute:: HASH
      :value: 'hash'



.. py:class:: AnalysisTechnique

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Enum object that defines the permissible analysis techniques.


   .. py:attribute:: SOURCE_CODE_ANALYSIS
      :value: 'source-code-analysis'



   .. py:attribute:: BINARY_ANALYSIS
      :value: 'binary-analysis'



   .. py:attribute:: MANIFEST_ANALYSIS
      :value: 'manifest-analysis'



   .. py:attribute:: AST_FINGERPRINT
      :value: 'ast-fingerprint'



   .. py:attribute:: HASH_COMPARISON
      :value: 'hash-comparison'



   .. py:attribute:: INSTRUMENTATION
      :value: 'instrumentation'



   .. py:attribute:: DYNAMIC_ANALYSIS
      :value: 'dynamic-analysis'



   .. py:attribute:: FILENAME
      :value: 'filename'



   .. py:attribute:: ATTESTATION
      :value: 'attestation'



   .. py:attribute:: OTHER
      :value: 'other'



.. py:class:: Method

   Represents a method used to extract and/or analyze evidence.

   .. note::
       See the CycloneDX Schema definition:
       https://cyclonedx.org/docs/1.7/json/#components_items_evidence_identity_oneOf_i0_items_methods


   .. py:attribute:: technique
      :type:  AnalysisTechnique


   .. py:attribute:: confidence
      :type:  decimal.Decimal


   .. py:attribute:: value
      :type:  Optional[str]


.. py:class:: Identity

   Our internal representation of the `identityType` complex type.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_identity


   .. py:attribute:: field
      :type:  IdentityField


   .. py:attribute:: confidence
      :type:  Optional[decimal.Decimal]


   .. py:attribute:: concluded_value
      :type:  Optional[str]


   .. py:attribute:: methods
      :type:  SortedSet[Method]


   .. py:attribute:: tools
      :type:  SortedSet[BomRef]


.. py:class:: Occurrence

   Our internal representation of the `occurrenceType` complex type.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_occurrences


   .. py:attribute:: location
      :type:  str


   .. py:attribute:: bom_ref
      :type:  cyclonedx.model.bom_ref.BomRef


   .. py:attribute:: line
      :type:  Optional[int]


   .. py:attribute:: offset
      :type:  Optional[int]


   .. py:attribute:: symbol
      :type:  Optional[str]


   .. py:attribute:: additional_context
      :type:  Optional[str]


.. py:class:: CallStackFrame

   Represents an individual frame in a call stack.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_callstack


   .. py:attribute:: module
      :type:  str


   .. py:attribute:: package
      :type:  Optional[str]


   .. py:attribute:: function
      :type:  Optional[str]


   .. py:attribute:: parameters
      :type:  SortedSet[str]


   .. py:attribute:: line
      :type:  Optional[int]


   .. py:attribute:: column
      :type:  Optional[int]


   .. py:attribute:: full_filename
      :type:  Optional[str]


.. py:class:: CallStack

   Our internal representation of the `callStackType` complex type.
   Contains an array of stack frames describing a call stack from when a component was identified.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#components_items_evidence_callstack


   .. py:attribute:: frames
      :type:  list[CallStackFrame]


.. py:class:: ComponentEvidence

   Our internal representation of the `componentEvidenceType` complex type.

   Provides the ability to document evidence collected through various forms of extraction or analysis.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_componentEvidenceType


   .. py:attribute:: identity
      :type:  SortedSet[Identity]


   .. py:attribute:: occurrences
      :type:  SortedSet[Occurrence]


   .. py:attribute:: callstack
      :type:  Optional[CallStack]


   .. py:attribute:: licenses
      :type:  cyclonedx.model.license.LicenseRepository


   .. py:attribute:: copyright
      :type:  SortedSet[Copyright]