Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ascoarchitect/wordpress-cognito-sync
Wordpress plugin for syncing your user directory with Amazon Cognito via API Gateway
https://github.com/ascoarchitect/wordpress-cognito-sync
aws cognito wordpress wordpress-plugin
Last synced: about 1 month ago
JSON representation
Wordpress plugin for syncing your user directory with Amazon Cognito via API Gateway
- Host: GitHub
- URL: https://github.com/ascoarchitect/wordpress-cognito-sync
- Owner: ascoarchitect
- License: gpl-3.0
- Created: 2024-11-25T22:35:58.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-26T12:47:17.000Z (about 2 months ago)
- Last Synced: 2024-11-26T13:24:10.039Z (about 2 months ago)
- Topics: aws, cognito, wordpress, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 440 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# WordPress Cognito Sync Plugin and AWS Integration
## Overview
The WordPress Cognito Sync plugin automatically synchronises WordPress user and group operations with Amazon Cognito User Pools using AWS API Gateway and Lambda. It supports full and test synchronisation options, detailed logs, and automatic account creation on user login.
Made with :heart: for the :earth_africa: by Adam Scott.
[](https://ko-fi.com/E1E3E8UBL)
**Missing a feature? Submit your contributions to make this better for everyone!**
## Features
* Synchronise WordPress users with Amazon Cognito User Pools
* Synchronise WordPress roles with Amazon Cognito groups
* Automatically create Cognito accounts on user login
* Full and test synchronisation options for users and groups
* Detailed logs and sync results
## Requirements
* WordPress 6.0 or higher
* PHP 7.2 or higher
* Developed on Wordpress 6.6.2 and PHP 8.2.26
* AWS account with existing Cognito User Pool and permissions to deploy API Gateway, IAM policies and Lambda Functions.
## Plugin Structure
```text
plugin/
assets/
includes/
Admin.php
API.php
Plugin.php
User.php
readme.txt
wp-cognito-sync.php
```
## Backend Infrastructure
The backend infrastructure is defined using AWS CloudFormation and includes the following components:
* Lambda Function: Handles user and group operations.
* API Gateway: Exposes the Lambda function as a REST API.
* IAM Roles: Provides necessary permissions for the Lambda function.
### CloudFormation Template
The CloudFormation template is located in cognito-sync-cloudformation.yaml. It defines the Lambda function, API Gateway, and IAM roles required for the plugin to communicate with AWS services.
### Data Flow Diagram
```mermaid
graph TD
A[WordPress Plugin] -->|HTTP Request| B[API Gateway]
B -->|Invoke| C[Lambda Function]
C -->|AWS SDK| D[Cognito User Pool]
```
## WordPress Plugin Functionality
### Initialisation
The plugin is initialised in wp-cognito-sync.php. It sets up the autoloading of classes and hooks into WordPress actions.
### Admin Interface
The admin interface is managed by the Admin class. It adds menu items, registers settings, and handles form submissions.
### Tabs
* Settings: Configure API Gateway URL and API key.
* Sync Management: Perform full or test synchronisation of users and groups.
* Logs: View synchronisation logs.
* Group Management: Manage synchronisation of WordPress roles with Cognito groups.
### User Synchronisation
The API class handles communication with the AWS Lambda function. It sends user and group data to the Lambda function for synchronisation with Cognito.
### User Flow
* User logs in to WordPress.
* The User class checks if the user exists in Cognito.
* If not, the user is created in Cognito.
* User data is synchronised with Cognito.
### Group Synchronisation
The plugin synchronises WordPress roles with Cognito groups. The Admin class manages the group synchronisation settings and actions.
### Deployment
#### Prerequisites
* AWS CLI configured with appropriate permissions.
* AWS CloudFormation template (infrastructure/cognito-sync-cloudformation.yaml).
#### Steps
* Create two custom attributes in your existing User Pool for storing Wordpress IDs:
Name: wp_user_id | Type: String | Mutable: Yes
Name: wp_username | Type: String | Mutable: Yes
wp_user_id is for storing the user ID reference against the Cognito user record, and wp_username is for supporting usernames which are not email addresses in Wordpress. The Cognito user ID will be stored against the user record in Wordpress to ensure that this is used for quick update matching in the future.
* Deploy the CloudFormation stack:
```bash
aws cloudformation deploy --template-file infrastructure/cognito-sync-cloudformation.yaml --stack-name wp-cognito-sync --parameter-overrides Environment=prod CognitoUserPoolId=xx-xxxx-x_xxxxxxxx
```
Note the API Gateway endpoint URL and API key from the CloudFormation stack outputs.
### Installation
* Upload the plugin files to the /wp-content/plugins/wp-cognito-sync directory, or install the plugin through the WordPress plugins screen directly.
* Activate the plugin through the 'Plugins' screen in WordPress.
* Use the Settings->Cognito Sync screen to configure the plugin with your API Gateway URL and API key.
### Conclusion
The WordPress Cognito Sync plugin provides seamless synchronisation between WordPress and Amazon Cognito User Pools. By leveraging AWS Lambda and API Gateway, it ensures that user and group data is consistently synchronised, providing a robust solution for managing user authentication and authorisation.
**This plugin is provided "as is" without any guarantees or warranty. In association with the product, the author makes no warranties of any kind, either express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, of title, or of non-infringement of third-party rights. Use of the product by a user is at the user’s risk.**