Sign In With BitBadges

This plugin allows users to gate their site with BitBadges – claims, payments, NFT badges, and more!

Important Note: This plugin ONLY handles authentication with BitBadges – it does not restrict access to your site by itself. For restricting access, we recommend using this plugin in conjunction with:

• Force Login – Forces users to log in to view your site
• Restrict Content – Restrict content to logged-in users
• Members – Advanced user roles and permissions
• Or other plugins that restrict access to your site

Translation

The Sign In With BitBadges plugin is currently available in English only. The plugin is translation-ready and uses WordPress’s internationalization system, making it easy to add support for additional languages in the future.

Configuration

1. Create a new application (OAuth App) in the BitBadges Developer Portal
2. Set your redirect URI to: https://your-wordpress-site.com/wp-login.php?action=bitbadges-callback
3. Copy your Client ID and Client Secret
4. Go to your WordPress admin panel > Settings > BitBadges SIWBB
5. Enter your Client ID and Client Secret
6. (Optional) Configure a claim ID to gate access and other additional settings
7. Save the settings

Features

• Adds a “Sign in with BitBadges” button to the WordPress login form
• Creates WordPress users automatically when they first sign in with BitBadges
• Secure OAuth 2.0 implementation with state verification
• Simple admin interface for configuration
• Optional exclusive BitBadges authentication mode (disable normal WordPress login)
• Claim-gated access support
• Emergency admin access URL for exclusive mode
• Customizable claim visibility on authorization page

Security

• CSRF protection using state parameter
• Secure storage of client credentials
• WordPress nonce verification
• Input sanitization
• Proper error handling
• Secure admin access fallback
• Claim verification

User Experience

• Clean, centered login button design
• Shortened wallet addresses for better readability
• Clear separation between traditional and BitBadges login
• Visible claim requirements before authentication
• Seamless first-time user setup

Requirements

• WordPress 5.0 or higher
• PHP 7.0 or higher
• HTTPS enabled on your site (required for secure OAuth)

Support

For support or feature requests, please visit the BitBadges website or create an issue in the GitHub repository.

License

This plugin is licensed under the GPL v2 or later.
License URI: https://www.gnu.org/licenses/gpl-2.0.html

External Services

This plugin connects to BitBadges (https://bitbadges.io) for authentication and claim verification. BitBadges is a blockchain-based authentication and digital credentials platform.

Service Endpoints Used

• Authentication: https://bitbadges.io/siwbb/authorize
• Token Management: https://api.bitbadges.io/api/v0/siwbb/token
• Claim Verification: https://api.bitbadges.io/api/v0/claims/success

Data Transmission

The plugin transmits the following data to BitBadges servers:

1. During Authentication:

   • Client ID and Secret (from your BitBadges OAuth app)
   • Redirect URI (your WordPress login callback URL)
   • State parameter (for security)

2. During Claim Verification:

   • User’s BitBadges address
   • Claim ID (if configured)
   • API key (for authentication)

3. Token Management:

   • Access tokens are stored in WordPress user meta
   • Tokens are used to verify user authentication status

No personal user data beyond the BitBadges address is transmitted to our servers. All communication is done over HTTPS.

Service Documentation

• Terms of Service: https://bitbadges.io/policies
• Privacy Policy: https://bitbadges.io/policies
• Developer Documentation: https://docs.bitbadges.io

BitBadges is required for this plugin to function. Without access to BitBadges services, users will not be able to authenticate or verify claims.