bloggios / authentication-configuration-jar Goto Github PK

Auth Configuration Jar

1. 🤖 Introduction
2. ⚙️ Tech Stack
3. 🔋 Documentation
4. 🤸 Quick Start
5. 🕸️ Contributing
6. 🔗 Links
7. 🙏 Support
8. ✨ Contributors

The Authentication Configuration Jar is a crucial component within the Bloggios Microservices ecosystem. Built using Java 17 and leveraging the Spring Boot Parent, this open-source project aims to enhance security practices across all microservices individually. By providing comprehensive end-to-end authentication, the jar streamlines security implementation, reduces boilerplate code, and ensures robust protection for each microservice.

1. Centralized Authentication Logic:

   • The jar encapsulates authentication-related logic, allowing developers to focus on business-specific functionality rather than repetitive security code.
   • By centralizing authentication, we ensure consistent practices across all microservices.

2. End-to-End Security:

   • The jar covers the entire authentication flow, from user login to token validation.
   • It seamlessly integrates with various authentication providers (e.g., OAuth, JWT, SAML) and supports custom authentication mechanisms.

3. Microservice-Specific Security:

   • Unlike traditional approaches that rely on an API Gateway for security, Bloggios adopts a microservice-centric model.
   • Each microservice independently handles security, tailoring it to its specific requirements.
   • This approach enhances flexibility, scalability, and resilience.

4. Reduced Boilerplate Code:

   • Developers no longer need to duplicate authentication-related code across microservices.
   • The jar abstracts away common tasks, such as token validation, session management, and user authentication.

• Improved Security Practices:

  • By applying security measures at the microservice level, we strengthen the overall security posture of Bloggios.
  • Developers can implement best practices without redundancy.

• Simplified Maintenance:

  • Updates or changes to authentication logic are made in one place—the jar—rather than across multiple microservices.
  • This simplifies maintenance and reduces the risk of inconsistencies.

• Community-Driven Development:

  • As an open-source project, the Authentication Configuration Jar encourages collaboration.
  • Developers worldwide can contribute, review, and enhance security features.

Join our newly active Discord community for support, bug reporting, and feature requests. Here, we strive to address every issue, and developers and testers can collaborate and assist each other effectively.

• Java 17
• Spring Boot
• OAuth2.0
• JWT

To help you get started with our API and understand all its features and endpoints, we have created detailed documentation available on Postman. This documentation includes comprehensive information about each endpoint, including:

• Endpoint URLs: Specific paths to access various functionalities.
• HTTP Methods: The method type (GET, POST, PUT, DELETE, etc.) for each endpoint.
• Parameters: Required and optional parameters, including headers, query parameters, and body content.
• Request Examples: Sample requests to demonstrate proper usage.
• Response Formats: Expected response structure, including status codes and data formats.
• Error Handling: Common error responses and troubleshooting tips.

To access the documentation:

1. **Visit our Postman Documentation Page **: Visit Documentation
2. Explore the Collection: Navigate through the collection to find detailed descriptions and examples for each endpoint.
3. Run Requests Directly in Postman: Use the "Run in Postman" button to directly import the collection into your Postman workspace for testing and exploration.

By leveraging the Postman documentation, you can quickly integrate our API into your application and take full advantage of its capabilities.

For any further assistance, feel free to contact our support team or refer to the additional resources section in the documentation.

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Git
• Java 17
• Intellij Idea or any other IDE supports Spring Boot

Cloning the Repository

git clone <repository-url>

Opening the Project

Open the project in any of your favourite IDE We recommended Intellij Idea

Make sure you have Java 17 Installed in your system Please execute the below command to check installed version of Java in your system

java --version

Replace the placeholder values with your actual credentials

Running or Compiling the Project

This is the configuration file repository only so there is no need to run this Repository

One can create a Jar of this application and use it in the other Microservices of Bloggios to Create a Jar please run the below command on root directory

mvn clean install

If Maven is not installed in your system then run

./mvnw clean install

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can,

• Star Repositories Bloggios
• Suggest a Feature
• Test the application, and help it improve.
• Improve the app, fix bugs, etc.
• Improve documentation.
• Create content about Bloggios and share it with the world.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

🆕 New to Open Source? 💡 Follow this guide to jumpstart your Open Source journey 🚀.

• Devsanbox API's URL - https://api.bloggios.in (Bloggios Devsandbox API)
• Devsandbox Environment - https://dev.bloggios.in (Bloggios Devsandbox) (Not Deployed yet)
• Production Environment - Not Deployed yet

Repositories

• Auth Provider Application - Visit Github
• User Provider Application - Visit Github
• Bloggios Mail Service - Visit Github
• Authentication Configuration Jar - Visit Github
• Bloggios Web UI - Visit Github

We all need support and motivation. Bloggios is not an exception. Please give this project repositories a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the app helpful, consider supporting us with a coffee.

Thanks goes to these wonderful people (emoji key):

Rohit Parihar 💻