diff --git a/docs/extensions/rucio-jupyterlab/authentication.md b/docs/extensions/rucio-jupyterlab/authentication.md new file mode 100644 index 0000000..55e72c7 --- /dev/null +++ b/docs/extensions/rucio-jupyterlab/authentication.md @@ -0,0 +1,42 @@ +# Authentication workflow + +The following files are responsible for the authentication workflow: + +``` +. +├── rucio_jupyterlab +│ ├── handlers +│ │ ├── auth_config.py +│ │ ├── handlers.py +│ ├── rucio +│ │ ├── authenticators.py +├── src +│ ├── components +│ │ ├── @Settings +│ │ │ ├── OIDCAuth.tsx +│ │ │ ├── SettingsTab.tsx +│ │ │ ├── UserPassAuth.tsx +│ │ │ ├── X509Auth.tsx +│ │ │ └── X509ProxyAuth.tsx +│ ├── types.ts +│ ├── utils +│ │ ├── Actions.tsx +│ │ ├── ApiRequest.ts +``` +Below is an example of the authentication workflow: + +![image](../../../static/img/auth-workflow.png) + +--- + +:::tip[Improving credentials validation] +Please look at: [jupyterlab-extension!71](https://github.com/rucio/jupyterlab-extension/pull/71) +``` +Validation and authentication improvements, logging enhancements: + + - Refactoring of the request URL construction in the API request function. + - Addition of OIDC token validation with related UI and API handling. + - Improved logging and error handling in authentication and handler modules. + +``` +::: \ No newline at end of file diff --git a/package.json b/package.json index c82f945..fd97646 100644 --- a/package.json +++ b/package.json @@ -14,9 +14,9 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "3.7.0", - "@docusaurus/preset-classic": "3.7.0", - "@docusaurus/theme-live-codeblock": "^3.7.0", + "@docusaurus/core": "3.8.0", + "@docusaurus/preset-classic": "3.8.0", + "@docusaurus/theme-live-codeblock": "^3.8.0", "@fortawesome/fontawesome-free": "^6.7.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", @@ -25,8 +25,8 @@ "react-dom": "^18.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.7.0", - "@docusaurus/types": "3.7.0" + "@docusaurus/module-type-aliases": "3.8.0", + "@docusaurus/types": "3.8.0" }, "browserslist": { "production": [ diff --git a/sidebars.js b/sidebars.js index 234cbd5..a659947 100644 --- a/sidebars.js +++ b/sidebars.js @@ -63,6 +63,11 @@ const sidebars = { type: 'doc', label: 'Monitoring', id: 'extensions/rucio-jupyterlab/monitoring', + }, + { + type: 'doc', + label: 'Authentication workflow', + id: 'extensions/rucio-jupyterlab/authentication', } ], diff --git a/static/img/auth-workflow.png b/static/img/auth-workflow.png new file mode 100644 index 0000000..f49eec1 Binary files /dev/null and b/static/img/auth-workflow.png differ