forked from auth0/wordpress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
151 lines (99 loc) · 10.3 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
=== Login by Auth0 ===
Tags: login, oauth, authentication, single sign on, ldap, active directory, saml, windows azure ad, google apps, two factor, two-factor, facebook, google, twitter, baidu, renren, linkedin, github, paypal, yahoo, amazon, vkontakte, salesforce, box, dwolla, yammer, passwordless, sms, magiclink, totp, social
Tested up to: 4.9.8
Requires at least: 3.8
Requires PHP: 5.3
License: GPLv2
License URI: https://github.com/auth0/wp-auth0/blob/master/LICENSE
Stable tag: trunk
Contributors: auth0, glena, rrauch, auth0josh
Login by Auth0 provides improved username/password login, Passwordless login, Social login and Single Sign On for all your sites.
== Description ==
This plugin replaces standard WordPress login forms with one powered by [Auth0](https://auth0.com) that enables:
- **Universal authentication**
- Over 30 social login providers
- Enterprise connections (ADFS, Active directory / LDAP, SAML, Office 365, Google Apps and more)
- Connect your own database
- Passwordless connections (using email or SMS)
- **Ultra secure**
- Multifactor authentication
- Password policies
- Email validation
- Mitigate brute force attacks
- **Easy access to your users data**
- User stats
- Profile data
- Login history and locations
== Installation ==
This plugin requires a [free or paid](https://auth0.com/pricing) Auth0 account. [Sign up here](https://auth0.com/signup) then follow the [installation instructions here](https://auth0.com/docs/cms/wordpress/installation).
== Screenshots ==
1. The new login page on WordPress
2. Twenty Seventeen theme with login widget
3. The admin to configure the plugin
4. Set up Enterprise connections
5. Set up the Auth0 widget
== Technical Notes ==
**IMPORTANT**: By using this plugin you are delegating the site authentication and profile handling to Auth0. That means that you won't be using the WordPress database to authenticate users and the default WordPress login forms will be replaced.
Please see our [How It Works page](https://auth0.com/docs/cms/wordpress/how-does-it-work) for more information on how Auth0 authenticates and manages your users.
= Migrating Existing Users =
Auth0 allows multiple authentication providers. You can have social providers like Facebook, Twitter, Google+, and more, a database of users and passwords (just like WordPress but hosted in Auth0), or you can use an Enterprise directory like Active Directory, LDAP, Office365, Google Apps, or SAML. All those authentication providers might give you an email and a flag indicating whether the email was verified or not. We use that email (only if its verified) to associate a previous **existing** user with the one coming from Auth0.
If the email was not verified and there is an account with that email in WordPress, the user will be presented with a page saying that the email was not verified and a link to "Re-send the verification email." For either scenario, you can choose whether it is mandatory that the user has a verified email or not in the plugin settings.
**Please note:** In order for a user to login using Auth0, they will need to sign up via the Auth0 login form (or have an account created for them in Auth0). Once signup is complete, their Auth0 user will be automatically associated with their WordPress user.
= Enabling dual (Auth0 and WordPress) login =
You can enable the standard WordPress login by turning on the "WordPress login enabled" setting (enabled by default). This will make visible a link on the login page to swap between both. Please note that logins using the standard WordPress form **will not** be tracked in Auth0.
== Usage ==
Once the plugin is configured, the login form on your wp-login.php page will be replaced with an Auth0 login form automatically. You can add additional login forms on the front-end of your site with widgets and/or shortcodes.
**Please note:**
- Only one login form can be displayed on the page at a time.
- The widget and shortcode login forms will not display if the user is already logged in.
- After logging in via widget or shortcode, the user will be redirected back to the same page where they logged in instead of the default login URL shown on the settings page.
- Both widget and shortcode login forms have an option to display a button that triggers the form in a modal.
= Widget =
You can enable the Auth0 as a WordPress widget in order to show it in a sidebar. The widget inherits the main plugin settings but can be overridden with its own settings in the widget form.
= Shortcode =
Also, you can use the Auth0 widget as a shortcode in your editor. Just add the following to use the global settings:
[auth0]
Like widgets, shortcode login forms will use the main plugins settings. It can be customized by adding the following attributes:
- `icon_url` - A direct URL to an image used at the top of the login form
- `form_title` - Text to appear at top of the login form
- `gravatar` - Display the user's Gravatar; set to `1` for yes
- `redirect_to` - A direct URL to use after successful login
- `social_big_buttons` - Display full-width social login buttons; set to `1` for yes
- `custom_css` - Valid CSS to alter the login form
- `custom_js` - Valid JS to alter the login form
- `dict` - Valid JSON to override form text ([see options here](https://github.com/auth0/lock/blob/master/src/i18n/en.js))
- `extra_conf` - Valid JSON to override Lock configuration ([see options here](https://auth0.com/docs/libraries/lock/v11/configuration))
- `show_as_modal` - Display a button which triggers the login form in a modal; set to `1` for yes
- `modal_trigger_name` - Button text to display when using a modal
Example:
[auth0 show_as_modal="1" social_big_buttons="1" modal_trigger_name="Login button: This text is configurable!"]
== Frequently Asked Questions ==
= Can I customize the Auth0 login form? =
The Auth0 login form is called Lock and it's [open source on GitHub](https://github.com/auth0/lock). You can style the form like any of your site components by enqueuing a stylesheet in your theme. Use the [`login_enqueue_scripts`](https://developer.wordpress.org/reference/hooks/login_enqueue_scripts/) hook to style the form on wp-login.php, [`wp_enqueue_scripts`](https://developer.wordpress.org/reference/hooks/wp_enqueue_scripts/) to style widgets and shortcodes, or both to affect the form in all locations.
= Can I access the user profile information? =
The Auth0 plugin transparently handles login information for your WordPress site and the plugins you use, so that it looks like any other login. User profile data changes in WordPress **are not** currently sent to Auth0 but changes to the Auth0 user account **are** stored in WordPress user meta (under the key `auth0_obj` prefixed with `$wpdb->prefix`).
= When I install this plugin, will existing users still be able to login? =
Yes, either allowing the WordPress login form to be displayed or by migrating existing users. See the **Technical Notes** section above.
= What authentication providers do you support? =
Please see our [complete list of supported social and enterprise authentication providers](https://auth0.com/docs/identityproviders).
= How can I use Lock configuration options that are not provided in the settings page? =
Use the "Extra Settings" field on the plugin settings' **Advanced** tab to add a JSON object with all additional configurations. For more information on what else can be configured, see the [documentation](https://auth0.com/docs/libraries/lock/v11/configuration).
= Is this plugin compatible with WooCommerce? =
Yes, this plugin will override the default WooCommerce login forms with the Auth0 login form.
= My question is not covered here ... what do I do? =
All is not lost!
* If you're setting up the plugin for the first time or having issues with users logging in, please review our [troubleshooting](https://auth0.com/docs/cms/wordpress/troubleshoot) and [configuration](https://auth0.com/docs/cms/wordpress/configuration) documentation.
* If you found a bug in the plugin code, please [submit an issue](https://github.com/auth0/wp-auth0/issues) or [create a pull request](https://github.com/auth0/wp-auth0/pulls) on GitHub.
* If you have questions about how to use Auth0 or the plugin, please [post on our community site](https://community.auth0.com/) or create a [support forum request here](https://wordpress.org/support/plugin/auth0).
* You can see additional documentation and answers on our [support site](https://support.auth0.com/). Customers on a paid Auth0 plan can [submit a trouble ticket](https://support.auth0.com/tickets) for a fast response.
== Changelog ==
**v3.8.1**
Bug fixes, see [CHANGELOG](https://github.com/auth0/wp-auth0/blob/master/CHANGELOG.md#380-2018-11-14) for details.
**v3.8.0**
- Administrators can now mark certain strategies as able to skip email verification. This is typically used for Enterprise strategies that do not provide an email verification flag. This should be used sparingly and only for connections that do not provide this flag.
- Password changes for WordPress users now work properly and are rejected clearly if Auth0 rejects the change (typically because the password does not conform to the password policy). A current API token is not required but your Application does need to allow for a Client Credentials grant with the Management API (this configured for you by default, [more information here](https://auth0.com/docs/cms/wordpress/configuration#authorize-the-application-for-the-management-api)).
- The `wp-login.php` page is no longer used for any callback processing. If you are using this page to process callbacks in a custom plugin or theme, please update to use the main callback URL for the implicit flow `/index.php?auth0=implicit`. In addition, users that are already logged in will be redirected to the default login page when accessing `wp-login.php`.
- Error logging has been improved in general, along with improvements to the error log display. Consecutive, duplicate errors are now combined, the error log now shows more entries, and entries can be cleared from the admin.
- The "Auto-Login" setting has been renamed to "Universal Login Page" and moved from the Advanced tab to the Features tab. The functionality is the same as before and will retain the existing setting.
- And more!
[Complete list of changes for this and other releases](https://github.com/auth0/wp-auth0/blob/master/CHANGELOG.md#380-2018-11-06)