cisagov / pe-reports

Automated process to build and distribute Posture & Exposure Reports' bi-weekly to customers.

Creative Commons Zero v1.0 Universal

17 stars 6 forks source link

Convert I-Score Views to Use API #570

Closed arng4108 closed 1 year ago

arng4108 commented 1 year ago

💡 Summary

Convert all I-Score related database queries to use the API.

Motivation and context

Making direct queries to the database poses a security risk, therefore we need switch to using the API instead.

Implementation notes

Will require creating models, schemas, endpoint, task, and db_query functions for each view
Will use Django ORM queryset syntax instead of PSQL
Changes made to the API will require a Django and Celery restart

Acceptance criteria

[X] model, schema, view, task, and db_query functions created for endpoints
[X] vw_iscore_vs_vuln API endpoint confirmed working
[X] vw_iscore_vs_vuln_prev API endpoint confirmed working
[X] vw_iscore_pe_vuln API endpoint confirmed working
[X] vw_iscore_pe_cred API endpoint confirmed working
[X] vw_iscore_pe_breach API endpoint confirmed working
[X] vw_iscore_pe_darkweb API endpoint confirmed working
[X] vw_iscore_pe_protocol API endpoint confirmed working
[X] vw_iscore_was_vuln API endpoint confirmed working
[X] vw_iscore_was_vuln_prev API endpoint confirmed working
[X] vw_kev_list API endpoint confirmed working
[X] Code review and merge changes

arng4108 commented 1 year ago

All I-Score API endpoint code has been added to the CD-pe-reports-api-extended branch. Eventually all this API work will be merged into develop all at once via the api-extended branch. These changes have not been merged into staging.