Download the PHP package askvortsov/flarum-auth-sync without Composer
On this page you can find all versions of the php package askvortsov/flarum-auth-sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download askvortsov/flarum-auth-sync
More information about askvortsov/flarum-auth-sync
Files in askvortsov/flarum-auth-sync
Package flarum-auth-sync
Short Description Manage Sync from External Identity Providers
License MIT
FAQ
Example:
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 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.
Informations about the package flarum-auth-sync
Flarum Auth Sync
A Flarum extension to sync user attributes when authenticated by an external identity provider. This extension provides support for syncing:
- Avatar
- Groups
- Bio
- Masquerade Attributes
Some authentication protocols, such as SAML2, LDAP, OpenID Connect, etc have the ability to send attributes along with an authentication response. This extension provides a framework for syncing user attributes and permissions via that attribute response.
Installation
Use Bazaar or install manually with composer:
Updating
How to Use
For flarum administrators, if you're using an authentication extension that uses flarum auth sync, you can use the settings popup on the Flarum Admin extensions page to choose which types of attributes you'd like to sync. Please note that in order to sync Bios and Masquerade Profile Fields, you need to install and enable the Friends of Flarum User Bios and Friends of Flarum Masquerade extensions.
To use this extension in another authentication extension:
- Import the AuthEventSync model via
use Askvortsov\FlarumAuthSync\Models\AuthSyncEvent; -
Before logging in/registering the user, create an AuthSyncEvent. Ex:
- Of course, replace the generic values above with attributes from your Identity Provider's response.
- Attributes should be provided in a json-encoded string (see above example). The JSON string should have the following attributes:
avatar: A URL pointing to an image for the user's avatar. Make sure that the file type is compatible with Flarum (jpeg or png I believe).groups: A comma-separated list of ids for groups that a user should belong to. Keep in mind that this will both add and remove groups, so make sure that all desired groups are included.bio: A string that will be synced to the user's bio if Friends of Flarum User Bios is enabledmasquerade_attributes: An associative array for any masquerade keys and attributes you want to sync. Make sure that the key matches the name of the profile field exactly.
This was originally developed for Flarum SAML2 SSO. For an example of how to integrate it, please see this line.
TODO
- Add better validation and error handling.
- Add a setting to support default groups that all users should be added to, and groups that users should never be synced to.
- Add an expiry setting for Auth Sync Events.
- Add support for getting users via LoginProvider providers and identifiers, in addition to email.
- Due to a bug in flarum core, the
LoggedInevent isn't dispatched when logging in via an external identity provider. Until this is fixed, the UserUpdatedListener listens toSerializeevents (except those going to masquerade). This workaround will be promptly removed when the upstream bug is fixed.
Feedback
Super excited to be posting my first extensions, hopefully more to follow! If you run into issues or have feature requests, let me know and I'll look into it!
