vault

Documentation

Overview

Package vault implements security best practices in order to store sensitive information, compliant with regulations.

Currently is able to store Payment Cards and Personal Identifiable Information.

Fireblaze Server aims to be PCI DSS Level 1 and HIPAA compliant.

todo: needs refactor

Index

• type Option
  • func WithAuth(client pb_user.UserClient) Option
  • func WithDebug(v bool) Option
  • func WithIIN(service iin.Service) Option
  • func WithReporting(client *errorreporting.Client) Option
  • func WithRisk(engine risk.Service) Option
• type Server
  • func New(ctx context.Context, db *ent.Client, kms kms.Service, opts ...Option) Server
  • func (s Server) DelCard(ctx context.Context, r *pb.DelCardRequest) (*empty.Empty, error)
  • func (s Server) DelPII(context.Context, *pb.DelPIIRequest) (*empty.Empty, error)
  • func (s Server) GetCard(ctx context.Context, r *pb.GetCardRequest) (w *pb.GetCardResponse, err error)
  • func (s Server) GetCardMetadata(ctx context.Context, r *pb.GetMetadataRequest) (*pb.CardMetadata, error)
  • func (s Server) GetPII(context.Context, *pb.GetPIIRequest) (*pb.GetPIIResponse, error)
  • func (s Server) HealthCheck(context.Context, *empty.Empty) (*empty.Empty, error)
  • func (s Server) HealthCheckVerbose(ctx context.Context, empty *empty.Empty) (*pb.HealthCheckResponse, error)
  • func (s Server) PutCard(ctx context.Context, r *pb.PutCardRequest) (w *pb.PutCardResponse, err error)
  • func (s Server) PutPII(context.Context, *pb.PutPIIRequest) (*pb.PutPIIResponse, error)
  • func (s Server) ServeGRPC(grpcPort string) error
  • func (s Server) ServeHTTP(httpPort, grpcPort string) error

Types

type Option

type Option func(*Server)

func WithAuth

func WithAuth(client pb_user.UserClient) Option

func WithDebug

func WithDebug(v bool) Option

func WithIIN

func WithIIN(service iin.Service) Option

func WithReporting

func WithReporting(client *errorreporting.Client) Option

func WithRisk

func WithRisk(engine risk.Service) Option

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server implements proto/card.proto.

func New

func New(ctx context.Context, db *ent.Client, kms kms.Service, opts ...Option) Server

New configures a new server.

func (Server) DelCard

func (s Server) DelCard(ctx context.Context, r *pb.DelCardRequest) (*empty.Empty, error)

DelCard removes all the data associated with a token from the database.

func (Server) DelPII

func (s Server) DelPII(context.Context, *pb.DelPIIRequest) (*empty.Empty, error)

func (Server) GetCard

func (s Server) GetCard(ctx context.Context, r *pb.GetCardRequest) (w *pb.GetCardResponse, err error)

func (Server) GetCardMetadata

func (s Server) GetCardMetadata(ctx context.Context, r *pb.GetMetadataRequest) (*pb.CardMetadata, error)

func (Server) GetPII

func (s Server) GetPII(context.Context, *pb.GetPIIRequest) (*pb.GetPIIResponse, error)

func (Server) HealthCheck

func (s Server) HealthCheck(context.Context, *empty.Empty) (*empty.Empty, error)

func (Server) HealthCheckVerbose

func (s Server) HealthCheckVerbose(ctx context.Context, empty *empty.Empty) (*pb.HealthCheckResponse, error)

func (Server) PutCard

func (s Server) PutCard(ctx context.Context, r *pb.PutCardRequest) (w *pb.PutCardResponse, err error)

func (Server) PutPII

func (s Server) PutPII(context.Context, *pb.PutPIIRequest) (*pb.PutPIIResponse, error)

func (Server) ServeGRPC

func (s Server) ServeGRPC(grpcPort string) error

func (Server) ServeHTTP

func (s Server) ServeHTTP(httpPort, grpcPort string) error