<commit_before>ep_oidc
=======

OIDC auth plugin for etherpad-lite

This plugin uses a passport.js strategy for OpenID Connect authentication,
through **passport-openidconnect** by [jaredhanson](https://github.com/jaredhanson/passport-openidconnect)

This plugin is mostly based on ep_oauth2 plugin by [HumanBrainProject](https://github.com/HumanBrainProject/ep_oauth2)

## Settings configuration

You must add the required keys to etherpad settings (here with example values):

``` json
"users": {
  "oidc": {
      issuer: "https://auth.yourserver.com",
      authorizationURL: "https://auth.yourserver.com/auth",
      tokenURL: "https://auth.yourserver.com/token",
      clientID: "YOUR_CLIENT_ID",
      clientSecret: "YOUR_CLIENT_SECRET",
      userinfoURL: "https://auth.yourserver.com/me",
      usernameKey: "name",
      useridKey: "sub",
      passReqToCallback: false,
      skipUserProfile: false,
      callbackURL: "https://etherpad.yourserver.com/auth/callback",
      responseType: "id_token",
      scope: ["profile"]
  }
 }
```

 ## Authorization

 Note, that this plugin does not implement authorization for your etherpad-lite, 
 so you must handle the authorization hook with another plugin (or create one yourself).
 Without the authorization, your etherpad-lite installation will not allow the user a permission to the pads,
 even though authenticated with ep_oidc.<commit_msg>Readme changes<commit_after>ep_oidc
=======

OIDC auth plugin for etherpad-lite

This plugin uses a passport.js strategy for OpenID Connect authentication,
through **passport-openidconnect** by [jaredhanson](https://github.com/jaredhanson/passport-openidconnect)

This plugin is mostly based on ep_oauth2 plugin by [HumanBrainProject](https://github.com/HumanBrainProject/ep_oauth2)

## Settings configuration

You must add the required keys to etherpad settings (here with example values):

``` json
"users": {
  "oidc": {
      issuer: "https://auth.yourserver.com",
      authorizationURL: "https://auth.yourserver.com/auth",
      tokenURL: "https://auth.yourserver.com/token",
      clientID: "YOUR_CLIENT_ID",
      clientSecret: "YOUR_CLIENT_SECRET",
      userinfoURL: "https://auth.yourserver.com/me",
      usernameKey: "name",
      useridKey: "sub",
      passReqToCallback: false,
      skipUserProfile: false,
      callbackURL: "https://etherpad.yourserver.com/auth/callback",
      responseType: "id_token",
      scope: ["profile"]
  }
 }
```
## Authorization

Note, that this plugin does not implement authorization for your etherpad-lite, 
so you must handle the authorization hook with another plugin (or create one yourself).
Without the authorization, your etherpad-lite installation will not allow the user a permission to the pads,
even though authenticated with ep_oidc.
{'fraction_non_alphanumeric': 0.10805008944543829, 'fraction_numerical': 0.0014311270125223613, 'mean_word_length': 4.235955056179775, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '842203', 'n_tokens_mistral': 845, 'n_tokens_neox': 813, 'n_words': 242}