Skip to content

feat(imap): allow choosing SASL mechanism via login options #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qaxi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(imap): allow choosing SASL mechanism via login options #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ IMAP user and password need to be given for the Nextcloud login.


### Configuration
The parameters are `host, port, sslmode, domain`.
The parameters are `host, port, sslmode, domain, stripDomain, groupDomain, loginOptions`.
Possible values for sslmode are `ssl` or `tls`.
Add the following to your `config.php`:

'user_backends' => array(
array(
'class' => '\OCA\UserExternal\IMAP',
'arguments' => array(
'127.0.0.1', 993, 'ssl', 'example.com', true, false
'127.0.0.1', 993, 'ssl', 'example.com', true, false, 'AUTH=DIGEST-MD5'
),
),
),
Expand All @@ -91,7 +91,13 @@ is set to true, after successfull login the domain part will be striped and
the rest used as username in Nextcloud. e.g. 'username@example.com' will be
'username' in Nextcloud. The sixth parameter toggles whether on creation of
the user, it is added to a group corresponding to the name of the domain part
of the address.
of the address. The seventh parameter is optional and allows you to specify
login options, for example which authentication method should be used
(`AUTH=PLAIN`, `AUTH=DIGEST-MD5`, `AUTH=NTLM`, `AUTH=GSSAPI` or `AUTH=*`).
This is useful when the server advertises a method that cannot be used from
Nextcloud (e.g. GSSAPI without Kerberos credentials). The value is passed to
curl as `CURLOPT_LOGIN_OPTIONS`, so the method has to be supported by both the
IMAP server and libcurl.

**⚠⚠ Warning:** If you are [**upgrading** from versions **<0.6.0**](https://github.com/nextcloud/user_external/releases/tag/v0.6.0), beside adapting your `config.php` you also have to change the `backend` column in the `users_external` table of the database. In your pre 0.6.0 database it may look like `{127.0.0.1:993/imap/ssl/readonly}INBOX` or similar, but now it has to be just `127.0.0.1` for everything to work flawless again. ⚠⚠

Expand Down
Loading