Download the PHP package cymdeveloppement/roundcube-new-oidc without Composer

On this page you can find all versions of the php package cymdeveloppement/roundcube-new-oidc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of cymdeveloppement/roundcube-new-oidc

Informations about the package roundcube-new-oidc

Roundcube New OIDC

Fork of roundcube-oidc with OIDC logout and auto-redirect support.

This plugin allows you to authenticate users to Roundcube using an OpenID Connect 1.0 provider. There are three modes to run the plugin in:

  1. Cleartext Password: The OIDC provider must supply the user's password in cleartext, which is then used to login to the IMAP server
  2. Master Password: In this mode (also falls back to this), a master password is used to login to the IMAP server with the username obtained from OIDC
  3. Master User: IMAP authentication is done using a master user (Dovecot) with a provided separator

Installation

Then copy and edit the configuration file:

Configuration

OIDC Provider

Option Type Default Description
oidc_url string '' URL of the OIDC provider
oidc_client string '' Client ID registered on the provider
oidc_secret string '' Client secret for the given client ID
oidc_scope string 'openid' OIDC scope to request

IMAP Authentication

Option Type Default Description
oidc_imap_master_password string '' Master password fallback if the provider does not supply a cleartext password
oidc_master_user_separator string '*' Separator for Dovecot master user authentication
oidc_config_master_user string '' Master user to append after separator. Leave blank to disable

User Fields Mapping

Option Type Default Description
oidc_field_uid string 'mail' OIDC claim for login UID (typically an email)
oidc_field_password string 'password' OIDC claim for cleartext password
oidc_field_server string 'imap_server' OIDC claim for IMAP server address

Login Page

Option Type Default Description
oidc_login_page string '' Path to an alternative login page. Errors are available as $ERROR
oidc_auto_redirect bool false Automatically redirect to OIDC provider, bypassing the login page

Logout

Option Type Default Description
oidc_logout_url string '' OIDC provider logout URL for Single Logout support

Example for Keycloak:

SMTP

Unless cleartext passwords are provided, SMTP must be configured to use no authentication or a master password.

Compatibility

License

MIT License

All versions of roundcube-new-oidc with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
roundcube/plugin-installer Version >=0.1.6
jumbojett/openid-connect-php Version ^0.9.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cymdeveloppement/roundcube-new-oidc contains the following files

Loading the files please wait ...