{"id":19357762,"url":"https://github.com/joomla-framework/cve-api","last_synced_at":"2025-04-13T07:56:24.498Z","repository":{"id":53098113,"uuid":"333792494","full_name":"joomla-framework/cve-api","owner":"joomla-framework","description":"Joomla Framework CVE package","archived":false,"fork":false,"pushed_at":"2024-10-08T21:11:36.000Z","size":81,"stargazers_count":0,"open_issues_count":5,"forks_count":3,"subscribers_count":9,"default_branch":"3.x-dev","last_synced_at":"2025-04-13T07:56:18.986Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joomla-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null},"funding":{"github":"joomla","custom":"https://community.joomla.org/sponsorship-campaigns.html"}},"created_at":"2021-01-28T15:00:35.000Z","updated_at":"2022-08-15T13:55:41.000Z","dependencies_parsed_at":"2023-02-18T16:31:01.318Z","dependency_job_id":null,"html_url":"https://github.com/joomla-framework/cve-api","commit_stats":{"total_commits":23,"total_committers":3,"mean_commits":7.666666666666667,"dds":0.08695652173913049,"last_synced_commit":"52ae3f893d626147aa1b6a0d3f56c6b50e333c39"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joomla-framework%2Fcve-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joomla-framework%2Fcve-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joomla-framework%2Fcve-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joomla-framework%2Fcve-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joomla-framework","download_url":"https://codeload.github.com/joomla-framework/cve-api/tar.gz/refs/heads/3.x-dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681489,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T07:09:05.746Z","updated_at":"2025-04-13T07:56:24.462Z","avatar_url":"https://github.com/joomla-framework.png","language":"PHP","funding_links":["https://github.com/sponsors/joomla","https://community.joomla.org/sponsorship-campaigns.html"],"categories":[],"sub_categories":[],"readme":"# The CVE Package [![Build Status](https://ci.joomla.org/api/badges/joomla-framework/cve-api/status.svg?ref=refs/heads/2.0-dev)](https://ci.joomla.org/joomla-framework/cve-api)\n\n[![Latest Stable Version](https://poser.pugx.org/joomla/cve/v/stable)](https://packagist.org/packages/joomla/cve)\n[![Total Downloads](https://poser.pugx.org/joomla/cve/downloads)](https://packagist.org/packages/joomla/cve)\n[![Latest Unstable Version](https://poser.pugx.org/joomla/cve/v/unstable)](https://packagist.org/packages/joomla/cve)\n[![License](https://poser.pugx.org/joomla/cve/license)](https://packagist.org/packages/joomla/cve)\n\n\u003e Requires PHP 7 \u003e= 7.3 or PHP 8 \u003c 8.2\n\n## Using the CVE Package\n\ntbd\n\n### Instantiating CVE\n\nInstantiating CVE Service is easy:\n\n```php\nuse Joomla\\Cve\\CveService;\n\n$cve = new CveService;\n```\n\nThis creates a basic Github object that can be used to access publicly available resources\non [mitre.org](https://cveawg.mitre.org).\n\nIn most cases it is necessary to specify additional options. This can be done by injecting in a Registry object with\nyour preferred options.\nSupport is available for optionally providing a custom CVE account username and password,\nas well as a custom URL for the CVE API server (as would be the case for testing purposes).\n\n```php\nuse Joomla\\Cve\\CveService;\nuse Joomla\\Registry\\Registry;\n\n$options = new Registry;\n$options-\u003eset('api.org', 'cve_org');\n$options-\u003eset('api.username', 'cve_username');\n$options-\u003eset('api.key', 'cve_key');\n$options-\u003eset('api.url', 'http://localhost:3000');\n\n$cve = new CveService($options);\n```\n\n#### Available Options\n\nOption key | Description\n----|----\n`api.key` | The key associated with the user to access the API.\n`api.org` | The organisation represented by the user.\n`api.url` | The URL for the API calls, defaults to 'https://cveawg.mitre.org/api'. Set it to 'http://localhost:3000' for integration tests against the cveawg Docker container.\n`api.username` | The username for the CVE account.\n`userAgent` | The user agent to use for requests. Defaults to 'Joomla-CVE/2.0'\n\n## Installation via Composer\n\nAdd `\"joomla/cve\": \"~2.0@dev\"` to the require block in your composer.json and then run `composer install`.\n\n```json\n{\n\t\"require\": {\n\t\t\"joomla/cve\": \"~2.0@dev\"\n\t}\n}\n```\n\nAlternatively, you can simply run the following from the command line:\n\n```sh\ncomposer require joomla/cve \"~2.0@dev\"\n```\n\nIf you want to include the test sources, use\n\n```sh\ncomposer require --prefer-source joomla/cve \"~2.0\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoomla-framework%2Fcve-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoomla-framework%2Fcve-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoomla-framework%2Fcve-api/lists"}