# EveSSO Plugin for DokuWiki

DokuWiki authentication via eve online SSO and access control for corporations/alliances/factions

[EveSSO on DokuWiki.org](https://www.dokuwiki.org/plugin:evesso)

## Installation

Search and install the plugin using the [Plugin Manager](https://www.dokuwiki.org/plugin:plugin). Refer to [Plugins](https://www.dokuwiki.org/plugins) on how to install plugins manually.

## Updating

### Updating from version 2021-11-02 or earlier

EVESSO change the way eve groups are named.  
They used to be:  
* eve-corp-*corporation_name*
* eve-alliance-*alliance_name*
* eve-faction-*faction_name*
* Group names had space replaced by underscore and dot replaced with hyphen-minus

Now they're:
* (corporation)*corporation_name*
* (alliance)*alliance_name*
* (faction)*faction_name*
* Names are identical to in-game names

## Configuration

#### Required Steps
1. Open the wiki in your browser
1. Login on a admin account
1. Go to `admin` > `Configuration Settings`
1. Go to `Authentication` > `authtype` and select `EVESSO`
1. Go to the `Evesso` section and enter your data from your [eve online developer app](https://developers.eveonline.com/applications)
    * `callback` (Callback URL)
    * `eveonline-key` (Client ID)
    * `eveonline-secret` (Secret Key)    
    * :warning: Do **not** change `singleService` (That will lock you out of the wiki)
1. Save the settings

#### Disable registration with email (Optional)

1. Open the wiki in your browser
1. Login on a admin account
1. Check `Evesso` > ` register-on-auth`
1. Go to `Authenticatio` > `disableactions`
1. Check `Register`
1. Save the settings

#### Disable login with email (Optional)

:warning:  
This have the potential to permantly lock you out of the wiki.  
It is a good idea [backup the wiki](https://www.dokuwiki.org/faq:backup) before you continue. 

1. Open the wiki in your browser
1. Logout *(if you're currently logged in)*
1. Login via EveSSO on the character you want to be admin
1. Logout
1. Login on a admin account
1. Go to `Admin` > `User Manager`
1. Click the eve character you want for the admin account
1. Add the group `admin` and click `Save Changes`
1. Logout and login with your EveSSO admin account
1. Go to `Admin` > `Configuration Settings`
1. go to `Evesso` > `singleService` and select `EVESSO (user menu)` or `EVESSO (login page)`
:warning:  
This step can lock you out of the wiki. Make sure you're logged in on a EveSSO admin account and have a up-to-date backup of the wiki before you continue
1. Save settings 

## Access Control

All EVESSO users will have both the `user` and `eveonline` group.
The will also have auth groups for their corporation, alliance *(if in alliance)*, and faction *(if in faction warfare)*:
* (corporation)*corporation_name*
* (alliance)*alliance_name*
* (faction)*faction_name*

You can change the access control for each auth group in `admin` > `Access Control List Management`

:warning: Do not create your own auth groups starting with those prefixes when using this plugin. They will be deleted when the user login.
:warning: ACL will allow access if any of the users group allow access

## License
[GNU General Public License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)

Original code from [OAuth](https://github.com/cosmocode/dokuwiki-plugin-oauth) and [PHPoAuthLib](https://github.com/Lusitanian/PHPoAuthLib)