UI5 onelogin middleware
👋 This is a community project and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
Middleware for ui5-server, enabling a generic login support.
The middleware will on first request try to login with the provided credentials and save the cookie for further requests. This uses playwright in a headless mode to run the login process. The first request will take longer.
This has been tested with Azure AD, Google, OpenAM and the SAP Gateway login pages.
Merge requests with other login handlers are more than welcome via pull request.
Prerequisites
- Requires at least
@ui5/cli@3.0.0
(to supportspecVersion: "3.0"
)
⚠️ UI5 Tooling Compatibility All releases of this tooling extension using the major version3
require UI5 Tooling V3. Any previous releases below major version3
(if available) also support older versions of the UI5 Tooling. But the usage of the latest UI5 Tooling is strongly recommended!
Install
npm install ui5-middleware-onelogin --save-dev
$yourapp/ui5.yaml
)
Configuration options (in Currently you can define the properties in the configuration (see below) or the following environment variables are used.
- path:
string
the url to the fiori launchpad or just hostname and port of the SAP system, /sap/bc/ui2/flp will then be automatically added - username
(optional)
:string
Username to be used to login to the launchpad - password
(optional)
:string
Password used to login - useCertificate
(optional)
:boolean
use a certificate to login instead of username and password - debug
(optional)
:boolean
true will open up the playwright browser so you can see what's going on
NB: If you choose to use the certificate login then check the property AutoSelectCertificateForUrls in chrome://policy if it holds the url pattern for your system. Playwright has an issue to handle the certificate prompt. Another workaround is to set debug and useCertificate to true in the configuration and press ok when the prompt opens
You can either add the following properties to your .env file, remember to add that to your .gitignore
- UI5_MIDDLEWARE_ONELOGIN_LOGIN_URL or UI5_MIDDLEWARE_SIMPLE_PROXY_BASEURI
- UI5_MIDDLEWARE_ONELOGIN_USERNAME
- UI5_MIDDLEWARE_ONELOGIN_PASSWORD
Use of environment variables or values set in a .env
file will be used.
Other options is to either set it in the yaml file or if left blank it will prompt you for the details.
You can choose to just add the url and let the rest be prompted in the terminal
Usage
- Define the dependency in
$yourapp/package.json
:
"devDependencies": {
// ...
"ui5-middleware-onelogin": "*"
// ...
}
- configure it in
$yourapp/ui5.yaml
:
server:
customMiddleware:
- name: ui5-middleware-onelogin
afterMiddleware: compression
configuration:
path: <Login URL>
username: <Login User>
password: <Login Password>
useCertificate: true / false (use a certificate to login instead of username and password)
debug: true / false (true will open up the playwright browser so you can see what's going on)
License
This work is dual-licensed under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.