documentation update (539445d1) · Commits · Zhang Yushan / cve-search

web/templates/api.html

+4 −4

Original line number	Diff line number	Diff line
		{% set api_set = ['cpe22', 'cpe23', 'cvefor', 'cve', 'cwe', 'capec', 'last', 'browse', 'search', 'dbInfo'] %}
		{% set api_set = ['cpe22', 'cpe23', 'cvefor', 'cve', 'cwe', 'capec', 'last', 'query', 'browse', 'search', 'link', 'dbInfo'] %}
		{% set api_admin_set = ['whitelist', 'blacklist', 'whitelist_export', 'blacklist_export', 'whitelist_import',
		'blacklist_import', 'whitelist_drop', 'blacklist_drop', 'whitelist_add', 'blacklist_add',
		'whitelist_remove', 'blacklist_remove', 'dbupdate'] %}
		{% set status_codes = ['success', 'authorization_method_not_allowed', 'malformed_authentication_string',
		'authentication_needed', 'authentication_failed', 'not_found', 'unknown_content-type',
		'internal_server_error', 'resource_unavailable'] %}
		{% set status_codes = ['success', 'skip_must_be_int', 'limit_must_be_int', 'authorization_method_not_allowed',
		'malformed_authentication_string', 'authentication_needed', 'authentication_failed',
		'not_found', 'unknown_content-type', 'internal_server_error', 'resource_unavailable'] %}
		<html lang="en">
		<head>
		<!-- metadata -->

web/templates/documentation/api/link

0 → 100644

+44 −0

Original line number	Diff line number	Diff line
		{% extends 'layouts/api-accordion-child' %}
		{% set id = "link" %}
		{% set title = "/api/link/<key>/<value>" %}
		{% set method = "GET" %}
		{% set args = [('key', "The key to link CVEs on", "msbulletin.bulletin_id"),
		('value', "The value for the given key", "MS16-098")] %}

		{% block desc %}
		Returns all CVEs that are linked by a given key/value pair
		{% endblock %}

		{% block output %}
		{
		"stats": {
		"count": 4,
		"maxCVSS": 7.2,
		"minCVSS": 7.2
		},
		"cves": [
		{
		"Modified": {
		"$date": 1474927194753
		},
		"Published": {
		"$date": 1470765557223
		},
		"access": {
		"authentication": "NONE",
		"complexity": "LOW",
		"vector": "LOCAL"
		},
		"cvss": "7.2",
		"cvss-time": {
		"$date": 1470923642083
		},
		"cwe": "CWE-264",
		"id": "CVE-2016-3310",
		"impact": {
		"availability": "COMPLETE",
		"confidentiality": "COMPLETE",
		"integrity": "COMPLETE"
		},
		...
		{% endblock %}

web/templates/documentation/api/query

0 → 100644

+45 −0

Original line number	Diff line number	Diff line
		{% extends 'layouts/api-accordion-child' %}
		{% set id = "query" %}
		{% set title = "/api/query" %}
		{% set method = "GET" %}
		{% set headers = [('rejected', "Hide or show rejected CVEs", "show(default)/hide"),
		('cvss_score', "CVSS score", "6.8"),
		('cvss_modifier', "Select the CVSS score of the CVEs related to cvss_score", "above/equals/below"),
		('time_start', "Earliest time for a CVE", "dd-mm-yyyy or dd-mm-yy format, using - or /"),
		('time_end', "Latest time for a CVE", "dd-mm-yyyy or dd-mm-yy format, using - or /"),
		('time_modifier', "Timeframe for the CVEs, related to the start and end time", "from/until/between/outside"),
		('time_type', "Select which time is used for the filter", "Modified/Published/last-modified"),
		('skip', "Skip the n latest vulnerabilities", "50"),
		('limit', "Limit the amount of vulnerabilities to return", "20"),
		]%}

		{% block desc %}
		Returns a list of CVEs matching the criteria of the filters specified in the headers.
		{% endblock %}

		{% block output %}
		[
		{
		"Modified": {
		"$date": 1480730341713
		},
		"Published": {
		"$date": 1480730340167
		},
		"cvss": 10.0,
		"cwe": "CWE-287",
		"id": "CVE-2016-9796",
		"last-modified": {
		"$date": 1481117600060
		},
		"references": [
		"http://blog.malerisch.net/2016/12/alcatel-omnivista-8770-unauth-rce-giop-corba.html",
		"http://www.securityfocus.com/bid/94649",
		"https://github.com/malerisch/omnivista-8770-unauth-rce",
		"https://www.youtube.com/watch?v=aq37lQKa9sk"
		],
		"summary": "Alcatel-Lucent OmniVista 8770 2.0 through 3.0 exposes different ORBs interfaces, which can be queried using the GIOP protocol on TCP port 30024. An attacker can bypass authentication, and OmniVista invokes methods (AddJobSet, AddJob, and ExecuteNow) that can be used to run arbitrary commands on the server, with the privilege of NT AUTHORITY\\SYSTEM on the server. NOTE: The discoverer states \"The vendor position is to refer to the technical guidelines of the product security deployment to mitigate this issue, which means applying proper firewall rules to prevent unauthorised clients to connect to the OmniVista server.\"",
		"vulnerable_configuration": [
		"cpe:2.3:a:alcatel-lucent:omnivista_8770_network_management_system:2.6",
		...
		{% endblock %}

web/templates/documentation/status_codes/limit_must_be_int

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		{% extends 'layouts/status_code_accordion-child' %}
		{% set id = "limit_must_be_int" %}
		{% set title = "'Limit' Must be an Integer" %}
		{% set code = 400 %}
		{% block desc %}
		The limit parameter in your query could not be parsed as an integer.
		{% endblock %}

web/templates/documentation/status_codes/skip_must_be_int

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		{% extends 'layouts/status_code_accordion-child' %}
		{% set id = "skip_must_be_int" %}
		{% set title = "'Skip' Must be an Integer" %}
		{% set code = 400 %}
		{% block desc %}
		The skip parameter in your query could not be parsed as an integer.
		{% endblock %}

Admin message