identity

README

Identity

Identity is a scalable and decentralized microservice for user identity management.

Prerequisites

NATS Server with JetStream: Refer to the official NATS website for installation instructions.

Dependency on NATS with JetStream

This project relies on NATS Server with JetStream functionality for its operations. Ensure that you have NATS Server with JetStream installed and running before using this project.

For installation instructions and details about NATS Server with JetStream, please refer to the official NATS website (https://nats.io).

Installation

You can install Identity using one of the following methods:

Binary

1. Clone the repository, navigate to the project directory, build, and install the binary using the following command:

   # clone the repository
   git clone https://github.com/mirror520/identity.git
   
   # navigate to the project directory
   cd identity
   
   # build and install
   go install
   

2. Copy the config.yaml file to the working directory. You can find an example configuration file in the project repository.

3. Set the necessary environment variables, such as IDENTITY_PATH and IDENTITY_HTTP_PORT, if required.

4. Run the installed binary to start the Identity microservice:

   identity
   

Docker

1. Make sure you have Docker installed and running on your system.

2. Run the following command to start the Identity microservice using Docker:

3. Copy the config.yaml file to the working directory. You can find an example configuration file in the project repository.

   docker run -d -p 8080:8080 mirror770109/identity:latest
   

   This command starts the Identity microservice in a Docker container, binds it to port 8080, and sets the IDENTITY_PATH and IDENTITY_HTTP_PORT environment variables. It also mounts the config.yaml file into the container at /root/.identity/config.yaml.

Helm Chart

1. Install Helm on your Kubernetes cluster if you haven't already.

2. Add the Helm repository:

   helm repo add mirror520 https://mirror520.github.io/charts
   helm repo update
   

3. Create a secrets.yaml file and manually inject your secrets into it.

4. Install the Identity chart with the provided values.yaml file:

   helm install identity mirror520/identity --values values.yaml
   

License

This project is licensed under the MIT License.

Documentation

Index

• Variables
• func AddSocialAccountEndpoint(svc Service) endpoint.Endpoint
• func EventEndpoint(svc Service) endpoint.Endpoint
• func OTPVerifyEndpoint(svc Service) endpoint.Endpoint
• func RegisterEndpoint(svc Service) endpoint.Endpoint
• func SignInEndpoint(svc Service) endpoint.Endpoint
• type AddSocialAccountRequest
• type OTPVerifyRequest
• type RegisterRequest
• type Service
  • func NewService(users user.Repository, cfg conf.Providers) Service
• type ServiceMiddleware
  • func LoggingMiddleware(log *zap.Logger) ServiceMiddleware
• type SignInRequest

Variables

var (
	ErrProviderNotSupported = errors.New("provider not supported")
	ErrClientIDNotFound     = errors.New("client id not found")
	ErrEmailNotFound        = errors.New("email not found")
	ErrNameNotFound         = errors.New("name not found")
	ErrPictureNotFound      = errors.New("picture not found")
)

Functions

func AddSocialAccountEndpoint

func AddSocialAccountEndpoint(svc Service) endpoint.Endpoint

func EventEndpoint

func EventEndpoint(svc Service) endpoint.Endpoint

func OTPVerifyEndpoint

func OTPVerifyEndpoint(svc Service) endpoint.Endpoint

func RegisterEndpoint

func RegisterEndpoint(svc Service) endpoint.Endpoint

func SignInEndpoint

func SignInEndpoint(svc Service) endpoint.Endpoint

Types

type AddSocialAccountRequest

type AddSocialAccountRequest struct {
	Credential string
	Provider   user.SocialProvider
	UserID     user.UserID
}

type OTPVerifyRequest

type OTPVerifyRequest struct {
	OTP    string
	UserID user.UserID
}

type RegisterRequest

type RegisterRequest struct {
	Username string
	Name     string
	Email    string
}

type Service

type Service interface {
	Register(username string, name string, email string) (*user.User, error)
	OTPVerify(otp string, id user.UserID) (*user.User, error)
	SignIn(credential string, provider user.SocialProvider) (*user.User, error)
	AddSocialAccount(credential string, provider user.SocialProvider, id user.UserID) (*user.User, error)

	UserRegisteredHandler(e *user.UserRegisteredEvent) error
	UserActivatedHandler(e *user.UserActivatedEvent) error
	UserSocialAccountAddedHandler(e *user.UserSocialAccountAddedEvent) error
}

func NewService

func NewService(users user.Repository, cfg conf.Providers) Service

type ServiceMiddleware

type ServiceMiddleware func(Service) Service

func LoggingMiddleware

func LoggingMiddleware(log *zap.Logger) ServiceMiddleware

type SignInRequest

type SignInRequest struct {
	Credential string
	Provider   user.SocialProvider
}