aa-charlink

AllianceAuth CharLink

A simple app for AllianceAuth that allows users to link each character to all the AllianceAuth apps with only 1 login action.

Overview

Basic usage

1. Select which app you want to link your character to
2. Login on CPP site
3. Character linked to the selected apps

Auditing

Users with the appropriate permission (see permissions) can audit the linked characters of the users of their corporation, alliance or auth state. A link will appear on top of the main page of the app and will redirect to a page with a table of all the linked characters of the users of the selected corporation.

A user can be audited by clicking on the link on the Main Character column.

App Audit: Users can now audit character based on the apps they have access to. Select the app you want to audit from the dropdown menu in the audit page. Admin App status: users with is_superuser can now see the list of imported apps and the ones with issues with the import.

Installation

1. Install the app with

   pip install aa-charlink
   

2. Add 'charlink', to your INSTALLED_APPS in local.py

3. Run migrations and collectstatic

   python manage.py migrate
   python manage.py collectstatic
   

Current apps

I've opened an issue to track the apps that have a default integration in CharLink and the WIPs. If you want another app to be supported, please comment on the issue, reach me on the AllianceAuth discord server or ask the developer of the app to implement an integration via hook.

Hook integration

From version 1.1.0, CharLink supports hook integration. If you want to integrate your app with CharLink, you need to register a hook in the auth_hooks.py file:

@hooks.register('charlink')
def register_charlink_hook():
   return 'testauth.testapp.charlink_hook'

The hook has to return a string with the import path of the module containing the app integration. The module must contain a variable called app_import which is an instance of charlink.app_imports.utils.AppImport. You can find the documentation of the class in the utils.py and some examples in the imports folder.

Settings

Name	Description	Default
CHARLINK_IGNORE_APPS	List of apps to ignore. Use the name of the app as it is called in INSTALLED_APPS	[]

Permissions

Name	Description
charlink.view_corp	Can view linked character of members of their corporation.
charlink.view_alliance	Can view linked character of members of their alliance.
charlink.view_state	Can view linked character of members of their auth state.

Login page url

If you want to setup a template override to link the "Add character" button to the login page of this package, set the a element to:

<a href="{% url 'charlink:index' %}" class="btn btn-primary flex-fill m-1" title="{% translate 'Add Character' %}">
      <span class="d-md-inline m-2">{% translate 'Add Character' %}</span>
</a>

Known issues

• For AFAT is not possible to check if the added character has a token which is still valid, it only checks if the character has ever added a token with the required scopes.