identity

package module
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 18, 2023 License: MIT Imports: 11 Imported by: 0

README

Identity Build Status

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 build -o $GOPATH/bin/identity cmd/main.go

  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

Constants

This section is empty.

Variables

View Source 
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 CheckHealth added in v1.0.6 

func CheckHealth(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 EndpointSet added in v1.0.3 

type EndpointSet struct {
	Register         endpoint.Endpoint
	SignIn           endpoint.Endpoint
	OTPVerify        endpoint.Endpoint
	AddSocialAccount endpoint.Endpoint
	CheckHealth      endpoint.Endpoint
}

type EventHandler added in v1.0.3 

type EventHandler interface {
	UserRegisteredHandler(e *user.UserRegisteredEvent) error
	UserActivatedHandler(e *user.UserActivatedEvent) error
	UserSocialAccountAddedHandler(e *user.UserSocialAccountAddedEvent) error
}

type Instance added in v1.0.3 

type Instance struct {
	ID            string
	Protocol      string
	Address       string
	Port          int
	RequestPrefix string
	ModifiedTime  time.Time
	IsAlive       bool

	Endpoints *EndpointSet
}

type OTPVerifyRequest 

type OTPVerifyRequest struct {
	OTP    string
	UserID user.UserID
}

type RegisterRequest 

type RegisterRequest struct {
	Username string
	Name     string
	Email    string
}

type RequestInfo added in v1.0.6 

type RequestInfo struct {
	ClientIP  string `json:"client_ip"`
	UserAgent string `json:"user_agent"`
}

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)
	CheckHealth(ctx context.Context) error

	Handler() (EventHandler, 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

func ProxyingMiddleware added in v1.0.3 

func ProxyingMiddleware(ctx context.Context, ch <-chan Instance) ServiceMiddleware

type SignInRequest 

type SignInRequest struct {
	Credential string
	Provider   user.SocialProvider
}

Source Files

View all Source files

Directories

Path Synopsis
db
inmem
kv
nats
http
pubsub

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.