PHP download

Download the PHP package cyclonedx/cyclonedx-library without Composer

On this page you can find all versions of the php package cyclonedx/cyclonedx-library. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download cyclonedx/cyclonedx-library
More information about cyclonedx/cyclonedx-library
Files in cyclonedx/cyclonedx-library

Vendor cyclonedx
Package cyclonedx-library
Short Description Work with CycloneDX documents.
License Apache-2.0
Homepage https://github.com/CycloneDX/cyclonedx-php-library/#readme

Keywords validator serializer models normalizer bom owasp vex vdr spdx package-url purl CycloneDX SBOM software-bill-of-materials bill-of-materials OBOM SaaSBOM HBOM

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of cyclonedx/cyclonedx-library

Informations about the package cyclonedx-library

CycloneDX PHP Library

Work with CycloneDX documents.
OWASP CycloneDX is a full-stack Bill of Materials (BOM) standard that provides advanced supply chain capabilities for cyber risk reduction.

Responsibilities

Provide a general purpose php-implementation of CycloneDX.
Provide phpDoc3- & psalm-compatible annotations for said implementation, so developers and dev-tools can rely on it.
Provide data models to work with CycloneDX.
Provide a JSON- and an XML-normalizer, that...
- supports all shipped data models.
- respects any injected CycloneDX Specification and generates valid output according to it.
- can prepare data structures for JSON- and XML-serialization.
Serialization:
- Provide a JSON-serializer.
- Provide an XML-serializer.
Validation against CycloneDX Specification:
- Provide a JSON-validator.
- Provide an XML-validator.
Provide composer-based autoloading for downstream usage.

Capabilities

Enums for the following use cases:
- ComponentType
- ExternalReferenceType
- HashAlgorithm
Data models for the following use cases:
- Bom
- BomRef, BomRefRepository
- Component, ComponentRepository, ComponentEvidence
- ExternalReference, ExternalReferenceRepository
- HashDictionary
- LicenseExpression, NamedLicense, SpdxLicense, LicenseRepository
- Metadata
- Property, PropertyRepository
- Tool, ToolRepository
Utilities for the following use cases:
- Generate valid random SerialNumbers for Bom.serialNumber
Factories for the following use cases:
- Create data models from any license descriptor string
Implementation of the CycloneDX Specification for the following versions:
- 1.6
- 1.5
- 1.4
- 1.3
- 1.2
- 1.1
Normalizers that convert data models to JSON structures
Normalizers that convert data models to XML structures
Serializer that converts Bom data models to JSON string
Serializer that converts Bom data models to XML string
Validator that checks JSON against CycloneDX Specification
Validator that checks XML against CycloneDX Specification

Installation

Install via composer:

Usage

See extended examples.

API Documentation

We ship code annotations, so that your IDE and tools may pick up the documentation when you use this library downstream.

There are also pre-rendered documentations hosted on readthedocs.

Additionally, there is a prepared config for phpDoc3 that you can use to generate the docs for yourself.

Conflicts

Due to the fact that this library was split out of /src/Core of cyclonedx-php-composer (346e6200fb2f5086061b15c2ee44f540893ce97d) it will conflict with its original source: cyclonedx/cyclonedx-php-composer:<3.5.

Contributing

Feel free to open issues, bug reports or pull requests.
See the CONTRIBUTING file for details.

License

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the LICENSE file for the full license.

All versions of cyclonedx-library with dependencies

PHP Build Version

Package Version

Version v3.1.2 Release 18. Mar 2024
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of cyclonedx-library from vendor cyclonedx

Requires php Version ^8.1
ext-dom Version *
ext-json Version *
ext-libxml Version *
composer/spdx-licenses Version ^1.5
opis/json-schema Version ^2.0
package-url/packageurl-php Version ^1.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cyclonedx/cyclonedx-library contains the following files

Loading the files please wait ....