README

fast, rich and API-based search for CVE and more (CPE, CWE, CAPEC)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/msn/fastcve-openapi.git"
    }
  ],
  "require": {
    "msn/fastcve-openapi": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/fastcve/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Msn\Apis\FastCVE\Api\SearchApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$page_idx = 0; // int | Results page index
$page_size = 10; // int | Results page size
$keyword = array('keyword_example'); // string[] | regexp to search for CPE in the description
$capec = array('capec_example'); // string[] | Related CAPEC IDs to search for

try {
    $result = $apiInstance->searchCAPECApiSearchCapecGet($page_idx, $page_size, $keyword, $capec);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->searchCAPECApiSearchCapecGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Models

• AccessComplexityType
• AccessVectorType
• AuthenticationType
• CollateralDamagePotentialType
• CommonModelsCpeType
• CommonModelsCveType
• CommonModelsCvssV2CiaRequirementType
• CommonModelsCvssV2CiaType
• CommonModelsCvssV2CveCvssDataModel
• CommonModelsCvssV2RemediationLevelType
• CommonModelsCvssV2Version
• CommonModelsCvssV30AttackComplexityType
• CommonModelsCvssV30AttackVectorType
• CommonModelsCvssV30CiaRequirementType
• CommonModelsCvssV30CiaType
• CommonModelsCvssV30ConfidenceType
• CommonModelsCvssV30CveCvssDataModel
• CommonModelsCvssV30ExploitCodeMaturityType
• CommonModelsCvssV30ModifiedAttackComplexityType
• CommonModelsCvssV30ModifiedAttackVectorType
• CommonModelsCvssV30ModifiedCiaType
• CommonModelsCvssV30ModifiedPrivilegesRequiredType
• CommonModelsCvssV30ModifiedScopeType
• CommonModelsCvssV30ModifiedUserInteractionType
• CommonModelsCvssV30PrivilegesRequiredType
• CommonModelsCvssV30RemediationLevelType
• CommonModelsCvssV30ScopeType
• CommonModelsCvssV30SeverityType
• CommonModelsCvssV30UserInteractionType
• CommonModelsCvssV30Version
• CommonModelsCvssV31AttackComplexityType
• CommonModelsCvssV31AttackVectorType
• CommonModelsCvssV31CiaRequirementType
• CommonModelsCvssV31CiaType
• CommonModelsCvssV31ConfidenceType
• CommonModelsCvssV31CveCvssDataModel
• CommonModelsCvssV31ExploitCodeMaturityType
• CommonModelsCvssV31ModifiedAttackComplexityType
• CommonModelsCvssV31ModifiedAttackVectorType
• CommonModelsCvssV31ModifiedCiaType
• CommonModelsCvssV31ModifiedPrivilegesRequiredType
• CommonModelsCvssV31ModifiedScopeType
• CommonModelsCvssV31ModifiedUserInteractionType
• CommonModelsCvssV31PrivilegesRequiredType
• CommonModelsCvssV31RemediationLevelType
• CommonModelsCvssV31ScopeType
• CommonModelsCvssV31SeverityType
• CommonModelsCvssV31UserInteractionType
• CommonModelsCvssV31Version
• Config
• CpeItem
• CpeMatch
• CpeOutput
• CveItem
• CveOutput
• CveSeverityV2
• CveSeverityV3
• CvssV2
• CvssV30
• CvssV31
• DefReference
• DefTitle
• Deprecate
• DeprecatedByItem
• ExploitabilityType
• HTTPValidationError
• LangString
• LocationInner
• Metrics
• Node
• Operator
• Reference
• ReportConfidenceType
• StatusItemOutput
• StatusOutput
• TargetDistributionType
• ValidationError
• VendorComment
• Weakness

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen