Update README and template #57
+144
−223
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| *** Settings *** | ||
| Documentation Shared keywords and variables for handling OIDC authentication | ||
|
|
||
| Library Collections | ||
| Library DateTime | ||
| Library Process | ||
| Library RequestsLibrary | ||
| Library JSONLibrary | ||
|
|
||
|
|
||
| *** Variables *** | ||
| ${REFRESH_TOKEN} ${REFRESH_TOKEN} | ||
| ${TOKEN_URL} ${AAI_URL} | ||
| ${CLIENT_ID} token-portal | ||
| ${SCOPE} openid%20email%20profile%20voperson_id%20eduperson_entitlement | ||
|
|
||
|
|
||
| *** Keywords *** | ||
| Check Valid OIDC Token | ||
| [Documentation] Get the access token | ||
| [Tags] create delete | ||
| ${token}= Get Access Token | ||
| Check JWT Expiration ${token} | ||
|
|
||
| Get Access Token | ||
| [Documentation] Retrieve OIDC token using a refresh token | ||
| ${result}= Run Process curl -s -X POST '${TOKEN_URL}' -d | ||
| ... 'grant_type\=refresh_token&refresh_token\=${REFRESH_TOKEN}&client_id\=${CLIENT_ID}&scope\=${SCOPE}' | ||
| ... shell=True stdout=True stderr=True | ||
| ${json_output}= Convert String To Json ${result.stdout} | ||
| ${access_token}= Get Value From Json ${json_output} $.access_token | ||
| VAR ${access_token}= ${access_token}[0] | ||
| Log Access Token: ${access_token} | ||
| VAR &{HEADERS}= Authorization=Bearer ${access_token} Content-Type=text/json Accept=application/json | ||
| ... scope=SUITE | ||
| VAR &{HEADERS_OSCAR}= Authorization=Basic ${BASIC_USER} Content-Type=text/json Accept=application/json | ||
| ... scope=SUITE | ||
| RETURN ${access_token} | ||
|
|
||
| Decode JWT Token | ||
| [Documentation] Decode a JWT token and returns its payload | ||
| [Arguments] ${token} | ||
| ${decoded}= Evaluate | ||
| ... jwt.decode('${token}', options={"verify_signature": False}, algorithms=["HS256", "RS256"]) | ||
| RETURN ${decoded} | ||
|
|
||
| Check JWT Expiration | ||
| [Documentation] Check if the given JWT token is expired | ||
| [Arguments] ${token} | ||
| ${decoded_token}= Decode JWT Token ${token} | ||
| Log ${decoded_token} | ||
| ${expiry_time}= Get From Dictionary ${decoded_token} exp | ||
| Log Token Expiration Time: ${expiry_time} | ||
| ${current_time}= Get Current Date result_format=epoch | ||
| Log Current Time: ${current_time} | ||
| Should Be True ${expiry_time} > ${current_time} Token is expired | ||
|
|
||
|
|
||
| Checks Valids OIDC Token | ||
| [Documentation] Get the access token | ||
| ${result}= Run Process curl -s -X POST '${TOKEN_URL}' -d | ||
| ... 'grant_type\=refresh_token&refresh_token\=${REFRESH_TOKEN}&client_id\=${CLIENT_ID}&scope\=${SCOPE}' | ||
| ... shell=True stdout=True stderr=True | ||
| ${json_output}= Convert String To Json ${result.stdout} | ||
| ${token}= Get Value From Json ${json_output} $.access_token | ||
| VAR ${token}= ${token}[0] | ||
| Check JWT Expiration ${token} | ||
| VAR &{HEADERS}= Authorization=Bearer ${token} Content-Type=text/json Accept=application/json | ||
| ... scope=SUITE | ||
| ${result}= Run Process curl -s -X POST '${TOKEN_URL}' -d | ||
| ... 'grant_type\=refresh_token&refresh_token\=${REFRESH_TOKEN_SECOND_USER}&client_id\=${CLIENT_ID}&scope\=${SCOPE}' | ||
| ... shell=True stdout=True stderr=True | ||
| ${json_output}= Convert String To Json ${result.stdout} | ||
| ${token2}= Get Value From Json ${json_output} $.access_token | ||
| VAR ${token2}= ${token2}[0] | ||
| Check JWT Expiration ${token2} | ||
| VAR &{HEADERS2}= Authorization=Bearer ${token2} Content-Type=text/json Accept=application/json | ||
| ... scope=SUITE |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,53 @@ | ||
| # MAIN OSCAR configuration | ||
| OSCAR_ENDPOINT: <COMPLETE> | ||
| OSCAR_METRICS: <COMPLETE> | ||
| OSCAR_DASHBOARD: <COMPLETE> | ||
| # Basic auth for OSCAR | ||
| BASIC_USER: <COMPLETE> | ||
| # Other configuration | ||
| LOCAL_TESTING: False | ||
| SSL_VERIFY: True | ||
|
|
||
|
|
||
|
|
||
| ##### EGI Authentication file example | ||
| AUTHENTICATION_PROCESS: resources/token-egi.resource | ||
| AAI_URL: https://aai.egi.eu/auth/realms/egi/protocol/openid-connect/token | ||
| AAI_VO: <COMPLETE> | ||
|
|
||
| #First user | ||
| REFRESH_TOKEN: <> | ||
| FIRST_USER: <>@egi.eu | ||
|
|
||
| #Second user for testing | ||
| REFRESH_TOKEN_SECOND_USER: <COMPLETE> | ||
| SECOND_USER: <>@egi.eu | ||
|
|
||
| # For testing mounting external buckets | ||
| OSCAR_EXTERNAL: https://<COMPLETE> | ||
| MINIO_EXTERNAL: https://minio.<COMPLETE> | ||
| MINIO_SECRET_KEY: <COMPLETE> | ||
|
|
||
|
|
||
|
|
||
| ##### Keycloak Authentication file example | ||
| AUTHENTICATION_PROCESS: resources/token-keycloak.resource | ||
| AAI_URL: https://<KEYCLOAK_HOST>/realms/<REALM>/protocol/openid-connect/token | ||
| AAI_VO: <COMPLETE> | ||
| CLIENT_ID: <COMPLETE> | ||
| SCOPE: <COMPLETE> | ||
|
|
||
| #First user | ||
| KEYCLOAK_USERNAME: <COMPLETE> | ||
| KEYCLOAK_PASSWORD: <COMPLETE> | ||
| FIRST_USER: <> | ||
|
|
||
| #Second user for testing | ||
| KEYCLOAK_USERNAME_AUX: <COMPLETE> | ||
| KEYCLOAK_PASSWORD_AUX: <COMPLETE> | ||
| SECOND_USER: <> | ||
|
|
||
| # For testing mounting external buckets | ||
| OSCAR_EXTERNAL: https://<COMPLETE> | ||
| MINIO_EXTERNAL: https://minio.<COMPLETE> | ||
| MINIO_SECRET_KEY: <> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you recommend two environment files, include templates for the two files (now we have a single .env-template.yaml file). Include the attributes in each file with sample fake values. Also, include an example on how to specify the two files to the robot command.