Consumer Authentication Service

The Consumer Authentication Service is a microservice designed to handle api consumers authentication and authorization within the Hire-Now platform. It manages api consumers registration (via command), JWT token generation, and validation.

Features

• API Consumers registration via command
• JWT token generation and validation

Technologies Used

• PHP 8.3
• Slim Framework (Microframework)
• MySQL
• JSON Web Tokens (JWT)
• Docker (Docker compose)
• Redis

Getting Started

Prerequisites

• PHP 8.3
• MySQL
• Docker

Installation

1. Clone the repository:

   git clone https://github.com/Hire-Now/consumer-auth-service.git
   cd consumer-auth-service

2. Install dependencies:

   composer install

3. Set up environment variables:

   • Rename .env.example to .env.
   • Update the variables in .env with your configuration.

4. Start the application:

    docker compose up -d --build

Message Routes

The Consumer Authentication Service uses a message-based communication model to handle authentication operations. Below are the message routes and their respective handlers:

Routes

1. Authenticate User

   • Channel: auth_consumer_channel
   • Message Type: authenticate
   • Handler: [ConsumerController::class, 'authenticate']
   • Description: Processes authentication requests by validating user credentials and generating a JWT token.

2. Validate Token

   • Channel: auth_consumer_channel
   • Message Type: check-token
   • Handler: [ConsumerController::class, 'validateToken']
   • Description: Validates the JWT token to ensure its authenticity and checks its expiration status.

Workflow Example

• Authenticate User:

  • The client publishes a message to the auth_consumer_channel with the type authenticate, including the user credentials in the payload.
  • The ConsumerController::authenticate handler processes the message and responds with a JWT token.

• Validate Token:

  • The client publishes a message to the auth_consumer_channel with the type check-token, providing the token in the payload.
  • The ConsumerController::validateToken handler verifies the token and responds with its validity and expiration information.

Note: Detailed documentation soon

Console Commands

The Consumer Authentication Service provides a command-line utility for managing API consumers. These commands are not routes but console commands executed via the CLI. Below is an overview of the main console command available:

Create a New API Consumer

• Command Name: api:consumer:create

• Description: Creates a new API consumer by generating a unique Client ID and Client Secret for authentication.

• Usage:

  php path/to/your/console app api:consumer:create {name} [--description=optional_description]

• Arguments:

  • name: The name of the API consumer (required).

• Options:

  • --description: An optional description for the API consumer.

• Example:

  php path/to/your/console app api:consumer:create "ConsumerName" --description="Description for this consumer"

• Output:

  • Upon successful execution, the command will generate and display:
    • A Client ID (used for identifying the API consumer).
    • A Client Secret (used for authenticating the API consumer).
      Note: Ensure you store the Client Secret securely, as it won't be retrievable again.

Command Implementation

The api:consumer:create command is implemented using Symfony's Console component. Here's a brief overview of its functionality:

1. The command generates a unique Client ID and a secure Client Secret.
2. It stores the new API consumer in the database using the ConsumerRepositoryPort.
3. Outputs the credentials to the console for secure storage.

This command simplifies API consumer management, allowing administrators to create new consumers without interacting with the database directly.

Testing

Note: Testing will be implemented soon

Contribution

We welcome contributions to enhance the Consumer Authentication Service. Please fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any inquiries or support, please contact [email protected].