API key authentication for REST API's #3013
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koolgax99
changed the title
Aariq
reviewed
Dec 22, 2022
Comment on lines
+48
to
+58
| validate_api_key <- function(api_key) { | ||
| res <- tbl(global_db_pool, "users") %>% | ||
| filter(apikey == api_key) %>% | ||
| collect() | ||
|
|
||
| if (nrow(res) == 1) { | ||
| return(res) | ||
| } | ||
|
|
||
| return(NA) | ||
| } |
There was a problem hiding this comment.
Not sure how you're planning on having the users store the API key, but often packages have users put it in a .Renviron file. Then, the validate_api_key can look for the key there by default. An example: https://github.com/ropensci/webchem/blob/18e551609c8f1aa371f83aad1b281540e9df1066/R/chemspider.R#L22
mdietze
approved these changes
Jan 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This feature will introduce the concept of API keys in the PEcAn REST API's, an API key shall be passed by the user in the header X-API-Key
The API would be more secure now and in the future we can use this API key to track the requests from the user.
Review Time Estimate
Types of changes
Checklist: