SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2025-02-05 13:52:33 -06:00
Code Issues Releases Activity

Edited the API Key header to comply with OpenAPI v3 specs

Browse source
This commit is contained in:
Solninja A 2025-01-03 00:25:55 +10:00
parent 9a0cdec646
commit 4fb8d0cb5c
3 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -193,17 +193,17 @@ If the API key is insecure, a warning will be outputted along with a generated A
To add a link: To add a link:
``` bash ``` bash
curl -X POST -H "Chhoto-Api-Key: <YOUR_API_KEY>" -d '{"shortlink":"<shortlink>", "longlink":"<longlink>"}' http://localhost:4567/api/new curl -X POST -H "X-API-Key: <YOUR_API_KEY>" -d '{"shortlink":"<shortlink>", "longlink":"<longlink>"}' http://localhost:4567/api/new
``` ```
To get a list of all the currently available links: To get a list of all the currently available links:
``` bash ``` bash
curl -H "Chhoto-Api-Key: <YOUR_API_KEY>" http://localhost:4567/api/all curl -H "X-API-Key: <YOUR_API_KEY>" http://localhost:4567/api/all
``` ```
To delete a link: To delete a link:
``` bash ``` bash
curl -X DELETE -H "Chhoto-Api-Key: <YOUR_API_KEY>" http://localhost:4567/api/del/<shortlink> curl -X DELETE -H "X-API-Key: <YOUR_API_KEY>" http://localhost:4567/api/del/<shortlink>
``` ```
Where `<shortlink>` is name of the shortened link you would like to delete. For example, if the shortened link is `http://localhost:4567/example`, `<shortlink>` would be `example`. Where `<shortlink>` is name of the shortened link you would like to delete. For example, if the shortened link is `http://localhost:4567/example`, `<shortlink>` would be `example`.

2
actix/src/auth.rs
View file

@ -42,7 +42,7 @@ pub fn gen_key() -> String {
// Check if the API key header exists // Check if the API key header exists
pub fn api_header(req: &HttpRequest) -> Option<&str> { pub fn api_header(req: &HttpRequest) -> Option<&str> {
req.headers().get("Chhoto-Api-Key")?.to_str().ok() req.headers().get("X-API-Key")?.to_str().ok()
} }
// Determine whether the inputted API key is sufficiently secure // Determine whether the inputted API key is sufficiently secure

7
actix/src/utils.rs
View file

@ -29,7 +29,7 @@ pub struct Response {
// If the api_key environment variable eists // If the api_key environment variable eists
pub fn is_api_ok(http: HttpRequest) -> Response { pub fn is_api_ok(http: HttpRequest) -> Response {
// If the api_key environment variable exists // If the api_key environment variable exists
if env::var("api_key").is_ok() { if let Ok(_) = env::var("api_key") {
// If the header exists // If the header exists
if let Some(header) = auth::api_header(&http) { if let Some(header) = auth::api_header(&http) {
// If the header is correct // If the header is correct
@ -41,11 +41,12 @@ pub fn is_api_ok(http: HttpRequest) -> Response {
// The header may not exist when the user logs in through the web interface, so allow a request with no header. // The header may not exist when the user logs in through the web interface, so allow a request with no header.
// Further authentication checks will be conducted in services.rs // Further authentication checks will be conducted in services.rs
} else { } else {
Response { success: false, error: false, reason: "Chhoto-Api-Key header not found".to_string(), pass: true } // Due to the implementation of this result in services.rs, this JSON object will not be outputted.
Response { success: false, error: false, reason: "X-API-Key header was not found".to_string(), pass: true }
} }
} else { } else {
// If the API key isn't set, but an API Key header is provided // If the API key isn't set, but an API Key header is provided
if auth::api_header(&http).is_some() { if let Some(_) = auth::api_header(&http) {
Response {success: false, error: true, reason: "An API key was provided, but the 'api_key' environment variable is not configured in the Chhoto URL instance".to_string(), pass: false} Response {success: false, error: true, reason: "An API key was provided, but the 'api_key' environment variable is not configured in the Chhoto URL instance".to_string(), pass: false}
} else { } else {
Response {success: false, error: false, reason: "".to_string(), pass: true} Response {success: false, error: false, reason: "".to_string(), pass: true}