openfga

README

OpenFGA

• 官方网站
• Github代码库
• 官方文档

支持的数据存储引擎：PostgreSQL、MySQL。

开发时支持内存存储引擎，但是一旦服务关机重启，数据将会丢失。

Docker安装

docker pull openfga/openfga:latest

docker run -itd --name openfga-server `
  -p 8080:8080 `
  -p 8081:8081 `
  -p 3000:3000 `
  openfga/openfga:latest run

• 8080 是GRPC的接口
• 8081 是HTTP的接口
• 3000 提供了playground：http://localhost:3000/playground
• 3001 提供了性能探查器

参考资料

• OpenFGA : Auth0’s an open-source authorization solution
• Announcing OpenFGA - Auth0’s Open Source Fine Grained Authorization System

Documentation

Index

• type Client
  • func NewClient(opts ...ClientOption) *Client
  • func (c *Client) CreateAuthorizationModel(ctx context.Context, writeAuthorizationModelRequestString string) (string, error)
  • func (c *Client) CreateRelationTuple(ctx context.Context, object, relation, subject string) error
  • func (c *Client) CreateStore(ctx context.Context, name string) error
  • func (c *Client) DeleteRelationTuple(ctx context.Context, object, relation, subject string) error
  • func (c *Client) DeleteStore() error
  • func (c *Client) ExpandRelationTuple(ctx context.Context, object, relation string) error
  • func (c *Client) GetCheck(ctx context.Context, object, relation, subject string) (bool, error)
  • func (c *Client) GetStore(ctx context.Context) string
  • func (c *Client) ListStore(ctx context.Context) (*[]openfga.Store, error)
  • func (c *Client) SetStoreId(id string) error
• type ClientOption
  • func WithApiUrl(apiUrl string) ClientOption
  • func WithClientId(clientId, clientSecret, apiAudience, apiTokenIssuer string) ClientOption
  • func WithStoreId(storeId string) ClientOption
  • func WithToken(token string) ClientOption

Types

type Client

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

func NewClient

func NewClient(opts ...ClientOption) *Client

func (*Client) CreateAuthorizationModel

func (c *Client) CreateAuthorizationModel(ctx context.Context, writeAuthorizationModelRequestString string) (string, error)

func (*Client) CreateRelationTuple

func (c *Client) CreateRelationTuple(ctx context.Context, object, relation, subject string) error

func (*Client) CreateStore

func (c *Client) CreateStore(ctx context.Context, name string) error

func (*Client) DeleteRelationTuple

func (c *Client) DeleteRelationTuple(ctx context.Context, object, relation, subject string) error

func (*Client) DeleteStore

func (c *Client) DeleteStore() error

func (*Client) ExpandRelationTuple

func (c *Client) ExpandRelationTuple(ctx context.Context, object, relation string) error

func (*Client) GetCheck

func (c *Client) GetCheck(ctx context.Context, object, relation, subject string) (bool, error)

func (*Client) GetStore

func (c *Client) GetStore(ctx context.Context) string

func (*Client) ListStore

func (c *Client) ListStore(ctx context.Context) (*[]openfga.Store, error)

func (*Client) SetStoreId

func (c *Client) SetStoreId(id string) error

type ClientOption

type ClientOption func(o *Client)

func WithApiUrl

func WithApiUrl(apiUrl string) ClientOption

func WithClientId

func WithClientId(clientId, clientSecret, apiAudience, apiTokenIssuer string) ClientOption

func WithStoreId

func WithStoreId(storeId string) ClientOption

func WithToken

func WithToken(token string) ClientOption