Skip to content

Latest commit

 

History

History
199 lines (144 loc) · 12.9 KB

README.md

File metadata and controls

199 lines (144 loc) · 12.9 KB
Raw

MockPass

A mock Singpass/Corppass/Myinfo v3/sgID v2 server for dev purposes

Quick Start (hosted remotely on Gitpod)

Gitpod Ready-to-Code

  • Click the ready-to-code badge above
  • Wait for MockPass to start
  • Make port 5156 public
  • Open browser to note the URL hosting MockPass
  • Configure your application per local machine quick start, changing the localhost:5156 to the Gitpod hostname

Quick Start (hosted locally)

Singpass v2 (NDI OIDC)

Configure your application to point to the following endpoints:

Configure your application (or MockPass) with keys:

  • EITHER configure MockPass with your application's JWKS endpoint URL using the env var SP_RP_JWKS_ENDPOINT.
  • OR configure your application to use the private keys from static/certs/oidc-v2-rp-secret.json.

MockPass accepts any value for client_id and redirect_uri.

Configuration item Explanation
Client signing and encryption keys Overview: When client makes any request, what signing key is used to verify the client's signature on the client assertion, and what encryption key is used to encrypt the data payload.
Default: static keyset static/certs/oidc-v2-rp-public.json is used.
How to configure: Set the env var SP_RP_JWKS_ENDPOINT to a JWKS URL that MockPass can connect to. This can be a HTTP or HTTPS URL.
Login page Overview: When client makes an authorize request, whether MockPass sends the client to a login page, instead of completing the login silently.
Default: Disabled for all requests.
How to configure: Enable for all requests by default by setting the env var SHOW_LOGIN_PAGE to true. Regardless of the default, you can override on a per-request basis by sending the HTTP request header X-Show-Login-Page with the value true.
Detailed effect: When login page is disabled, MockPass will immediately complete login and redirect to the redirect_uri. The profile used will be (in order of decreasing precedence) the profile specified in HTTP request headers (X-Custom-NRIC and X-Custom-UUID must both be specified), the profile with the NRIC specified in the env var MOCKPASS_NRIC, or the first profile in MockPass' static data.
When login page is enabled, MockPass returns a HTML page with a form that is used to complete the login. The client may select an existing profile, or provide a custom NRIC and UUID on the form.

Corppass v2 (Corppass OIDC)

Configure your application to point to the following endpoints:

Configure your application (or MockPass) with keys:

  • EITHER configure MockPass with your application's JWKS endpoint URL using the env var CP_RP_JWKS_ENDPOINT. HTTP/HTTPS endpoints are supported.
  • OR configure your application to use the private keys from static/certs/oidc-v2-rp-secret.json.

MockPass accepts any value for client_id and redirect_uri.

Configuration item Explanation
Client signing and encryption keys Overview: When client makes any request, what signing key is used to verify the client's signature on the client assertion, and what encryption key is used to encrypt the data payload.
Default: static keyset static/certs/oidc-v2-rp-public.json is used.
How to configure: Set the env var CP_RP_JWKS_ENDPOINT to a JWKS URL that MockPass can connect to. This can be a HTTP or HTTPS URL.
Login page Overview: When client makes an authorize request, whether MockPass sends the client to a login page, instead of completing the login silently.
Default: Disabled for all requests.
How to configure: Enable for all requests by default by setting the env var SHOW_LOGIN_PAGE to true. Regardless of the default, you can override on a per-request basis by sending the HTTP request header X-Show-Login-Page with the value true.
Detailed effect: When login page is disabled, MockPass will immediately complete login and redirect to the redirect_uri. The profile used will be (in order of decreasing precedence) the profile specified in HTTP request headers (X-Custom-NRIC, X-Custom-UUID, X-Custom-UEN must all be specified), the profile with the NRIC specified in the env var MOCKPASS_NRIC, or the first profile in MockPass' static data.
When login page is enabled, MockPass returns a HTML page with a form that is used to complete the login. The client may select an existing profile, or provide a custom NRIC, UUID and UEN on the form.

Myinfo v3

Configure your application to point to the following endpoints:

Configure your application (or MockPass) with certificates/keys:

  • Provide your application with the certificate static/certs/spcp.crt as the Myinfo public certificate.
  • EITHER configure MockPass with your application's X.509 certificate by setting the env vars SERVICE_PROVIDER_PUB_KEY and SERVICE_PROVIDER_CERT_PATH to the path to the certificate in PEM format. Self-signed or untrusted certificates are supported.
  • OR configure your application to use the certificate and private key from static/certs/(server.crt|key.pem).

MockPass accepts any value for client_id, redirect_uri and sp_esvcId. The client_secret value will be checked if configured, see below.

Only the profiles (NRICs) that have entries in Mockpass' personas dataset will succeed, using other NRICs will result in an error. See the list of personas in static/myinfo/v3.json.

Configuration item Explanation
Client certificate Overview: When client makes any request, what certificate is used to verify the request signature, and what certificate is used to encrypt the data payload.
Default: static certificate/key static/certs/(server.crt|key.pub) are used.
How to configure: Set the env var SERVICE_PROVIDER_PUB_KEY to the path to a public key PEM file, and SERVICE_PROVIDER_CERT_PATH to the path to a certificate PEM file. (A certificate PEM file can also be provided to SERVICE_PROVIDER_PUB_KEY, despite the env var name.)
Client secret Overview: When client makes a Token request, whether MockPass verifies the request signature.
Default: Disabled.
How to configure: Enable for all requests by setting the env var SERVICE_PROVIDER_MYINFO_SECRET to some non-blank string. Provide this value to your application as well.
Payload encryption Overview: When client makes a Person or Person-Basic request, whether MockPass encrypts the data payload. When client makes a Person request, whether MockPass verifies the request signature.
Default: Disabled.
How to configure: Enable for all requests by setting the env var ENCRYPT_MYINFO to true.

To emulate the equivalent of the Test environment on Myinfo v3, you must both set a client secret and enable payload encryption on MockPass.

sgID v2

Configure your application to point to the following endpoints:

Configure your application (or MockPass) with certificates/keys:

  • Provide your application with the certificate static/certs/spcp.crt as the sgID public key, or use the signing key published at the JWKS endpoint.
  • EITHER configure MockPass with your application's X.509 certificate using the env var SERVICE_PROVIDER_PUB_KEY, as the path to the certificate in PEM format. Self-signed or untrusted certificates are supported.
  • OR configure your application to use the certificate and private key from static/certs/(server.crt|key.pem).

MockPass accepts any value for client_id, client_secret and redirect_uri.

Only the profiles (NRICs) that have entries in Mockpass' personas dataset will succeed, using other NRICs will result in an error. See the list of personas in static/myinfo/v3.json.

If the Public Officer Employment Details data item is requested, the pocdex.public_officer_details scope data is sourced from the publicofficerdetails data key (where present) on personas. Most personas do not have this data key configured, and will result in a "NA" response instead of an stringified array. As these personas are not identified in the login page dropdown, please check the personas dataset linked above to identify them. The pocdex.number_of_employments scope is not supported.

Configuration item Explanation
Client certificate Overview: When client makes any request, what certificate is used to verify the request signature, and what certificate is used to encrypt the data payload.
Default: static key static/certs/key.pub is used.
How to configure: Set the env var SERVICE_PROVIDER_PUB_KEY to the path to a public key PEM file. (A certificate PEM file can also be provided, despite the env var name.)
Login page Overview: When client makes an authorize request, whether MockPass sends the client to a login page, instead of completing the login silently.
Default: Disabled for all requests.
How to configure: Enable for all requests by default by setting the env var SHOW_LOGIN_PAGE to true. Regardless of the default, you can override on a per-request basis by sending the HTTP request header X-Show-Login-Page with the value true.
Detailed effect: When login page is disabled, MockPass will immediately complete login and redirect to the redirect_uri. The profile used will be (in order of decreasing precedence) the profile with the NRIC specified in the env var MOCKPASS_NRIC, or the first profile in MockPass' static data.
When login page is enabled, MockPass returns a HTML page with a form that is used to complete the login. The client may select an existing profile, or provide a custom NRIC and UUID on the form.

Singpass/Corppass v1 (legacy)

The v1 APIs should no longer be in use, see the v2 APIs above!

Configure your application to point to the following endpoints:

Singpass (v1 - Singpass OIDC):

Corppass (v1 - Corppass OIDC):

Configure your application with keys and/or certificates:

Provide your application with the certificate static/certs/spcp.crt as the Singpass/Corppass public certificate. Provide the path to your application's X.509 certificate in PEM format as env var SERVICE_PROVIDER_CERT_PATH when running MockPass. Self-signed or untrusted certificates are supported. Alternatively, provide your application with the certificate and private key from static/certs/(server.crt|key.pem).

Run MockPass

Common configuration:

Configuration item Explanation
Port number Overview: What port number MockPass will listen for HTTP requests on.
Default: 5156.
How to configure: Set the env var MOCKPASS_PORT or PORT to some port number.
Stateless Mode Overview: Enable for environments where the state of the process is not guaranteed, such as in serverless contexts.
Default: not set.
How to configure: Set the env var MOCKPASS_STATELESS to true or false.

Run MockPass:

$ npm install @opengovsg/mockpass

# Configure the listening port if desired, defaults to 5156
$ export MOCKPASS_PORT=5156

# Configure any other options if required
$ export SHOW_LOGIN_PAGE=false
$ export MOCKPASS_NRIC=S8979373D
$ export SERVICE_PROVIDER_MYINFO_SECRET=<your secret here>
$ export ENCRYPT_MYINFO=false

$ npx mockpass
MockPass listening on 5156

# Alternatively, just run directly with npx
MOCKPASS_PORT=5156 SHOW_LOGIN_PAGE=false MOCKPASS_NRIC=S8979373D npx @opengovsg/mockpass@latest

Contributing

We welcome contributions to code open-sourced by the Government Technology Agency of Singapore. All contributors will be asked to sign a Contributor License Agreement (CLA) in order to ensure that everybody is free to use their contributions.