Skip to content

Add API authentication, key request and documentation - #987

Merged
pombredanne merged 38 commits into
mainfrom
api-authentication
Nov 8, 2022
Merged

Add API authentication, key request and documentation#987
pombredanne merged 38 commits into
mainfrom
api-authentication

Conversation

@pombredanne

Copy link
Copy Markdown
Member

This PRs adds:

  • API authentication using an API key
  • OpenAPI live documentation with swagger and drf-spectacular
  • API key self request
    It also streamlines and improve minimally other misc. code.

@pombredanne
pombredanne requested a review from TG1999 October 28, 2022 14:16
@TG1999
TG1999 force-pushed the api-authentication branch from 1e7cd95 to e33f79a Compare November 1, 2022 18:46
pombredanne and others added 28 commits November 4, 2022 19:14
Setting VULNERABLECODEIO_REQUIRE_AUTHENTICATION will require auth
with an API key

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
This is handy for data browsing

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Also add minimal API auth and configuration documentation

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
* Create a new ApiUser proxy model to create a minimal admin.
* Streamline code and validate that a username is a valid email.
* Update the management command accordingly to share common code

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
* Use shared footer
* Move navbar to base template to avoid duplication

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
This will help generate an Open API documentation now that we do not
have CDN issues anymore with:
tfranzel/drf-spectacular#389

Referenced-by: #454
Thanks-you-to: T. Franzel @tfranzel
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
vulnerabilities.models.VulnerabilitySeverity "scoring_system" was
invalid and had been damaged in a past search and replace in this
commit:

4988452

This reparing this mistake.

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
This helps generate a better OpenAPI schema

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
This is no longer needed as the OpenAPI schema is available directly
though drf-spectacular

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
And streamline urls

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Override the swagger UI template
Format and improve settings and ruls.py

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne and others added 10 commits November 4, 2022 19:14
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Prefer underscore to dash

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
@TG1999
TG1999 force-pushed the api-authentication branch from 3ce82f7 to 86d5f86 Compare November 4, 2022 13:55

@pombredanne pombredanne left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, merging

@pombredanne
pombredanne merged commit c9f70a0 into main Nov 8, 2022
@pombredanne
pombredanne deleted the api-authentication branch November 8, 2022 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants