Source code for nvdlib.cpe

import datetime

from datetime import datetime
from .get import __get
from .classes import __convert

def searchCPE(
        cpeNameId=False,
        cpeMatchString=False,
        keywordExactMatch=False,
        keywordSearch=False,
        lastModStartDate=False,
        lastModEndDate=False,
        matchCriteriaId=False,
        limit=False,
        key=False,
        delay=False,
        verbose=False):
    """Build and send GET request then return list of objects containing a collection of CPEs.
    
    :param cpeNameId: Returns a specific CPE record using its UUID. If a correctly formatted UUID is passed but it does not exist, it will return empty results. The UUID is the `cpeNameId` value when searching CPE.
    :type cpeNameId: str

    :param cpeMatchString: Use a partial CPE name to search for other CPE names. 
    :type cpeMatchString: str

    :param keywordExactMatch: Searches metadata within CPE title and reference links for an exact match of the phrase or word passed to it. Must be included with `keywordSearch`.
    :type keywordExactMatch: bool

    :param keywordSearch: Returns CPE records where a word or phrase is found in the metadata title or reference links. Space characters act as an `AND` statement.
    :type keywordSearch: str

    :param lastModStartDate: CPE last modification start date. Maximum 120 day range. A start and end date is required. All times are in UTC 00:00.

        A datetime object or string can be passed as a date. NVDLib will automatically parse the datetime object into the correct format.

        String Example: '2020-06-28 00:00'
    :type lastModStartDate: str/datetime obj

    :param lastModEndDate: CPE last modification end date. Maximum 120 day range. Must be included with lastModStartDate.
        Example: '2020-06-28 00:00'
    :type lastModEndDate: str/datetime obj

    :param limit: Limits the number of results of the search.
    :type limit: int

    :param key: NVD API Key. Allows for a request every 0.6 seconds instead of 6 seconds.
    :type key: str

    :param delay: Can only be used if an API key is provided. The amount of time to sleep in between requests. Must be a value above 0.6 seconds if an API key is present. `delay` is set to 6 seconds if no API key is passed.
    :type verbose: bool   

    :param verbose: Prints the URL request for debugging purposes.
    :type verbose: bool
    """


    def __buildCPECall(
        cpeNameId,
        cpeMatchString,
        keywordExactMatch,
        keywordSearch,
        lastModStartDate,
        lastModEndDate,
        matchCriteriaId,
        limit,
        key,
        delay):

        parameters = {}

        if cpeNameId:
            parameters['cpeNameId'] = cpeNameId

        if cpeMatchString:
            parameters['cpeMatchString'] = cpeMatchString

        if keywordExactMatch:
            if keywordSearch:
                parameters['keywordExactMatch'] = None
            else:
                raise SyntaxError('keywordSearch parameter must be passed if keywordExactMatch is set to True.')
        
        if keywordSearch:
            parameters['keywordSearch'] = keywordSearch
        
        if lastModStartDate:
            if isinstance(lastModStartDate, datetime):
                date = lastModStartDate.isoformat()
            elif isinstance(lastModStartDate, str):
                date = datetime.strptime(lastModStartDate, '%Y-%m-%d %H:%M').isoformat()
            else:
                raise SyntaxError('Invalid date syntax: ' + lastModStartDate)
            parameters['lastModStartDate'] = date

        if lastModEndDate:
            if isinstance(lastModEndDate, datetime):
                date = lastModEndDate.isoformat()
            elif isinstance(lastModEndDate, str):
                date = datetime.strptime(lastModEndDate, '%Y-%m-%d %H:%M').isoformat()
            else:
                raise SyntaxError('Invalid date syntax: ' + lastModEndDate)
            parameters['lastModEndDate'] = date

        if matchCriteriaId:
            parameters['matchCriteriaId'] = matchCriteriaId

        if limit:
            if limit > 2000 or limit < 1:
                raise SyntaxError('Limit parameter must be between 1 and 2000')
            parameters['resultsPerPage'] = limit

        if key:
            headers = {'content-type': 'application/json', 'apiKey': key}
        else:
            headers = {'content-type': 'application/json'}

        if delay and key:
            if delay < 0.6:
                raise SyntaxError('Delay parameter must be greater than 0.6 seconds with an API key. NVD API recommends several seconds.')
        elif delay and key == False:
            raise SyntaxError('Key parameter must be present to define a delay. Requests are delayed 6 seconds without an API key by default.')

        return parameters, headers

    # Build the URL for the request
    parameters, headers = __buildCPECall(
        cpeNameId,
        cpeMatchString,
        keywordExactMatch,
        keywordSearch,
        lastModStartDate,
        lastModEndDate,
        matchCriteriaId,
        limit,
        key,
        delay)

    # Send the GET request for the JSON and convert to dictionary
    raw = __get('cpe', headers, parameters, limit, verbose, delay)
    cpes = []
    # Generates the CVEs into objects for easy referencing and appends them to self.cves
    for eachCPE in raw['products']:
        cpe = __convert('cpe', eachCPE['cpe'])
        cpes.append(cpe)
    return cpes