https://github.com/datum-cloud/fgax

fga eXtensions
https://github.com/datum-cloud/fgax

Last synced: about 2 months ago
JSON representation

fga eXtensions

• Host: GitHub
• URL: https://github.com/datum-cloud/fgax
• Owner: datum-cloud
• License: apache-2.0
• Created: 2024-08-30T22:01:51.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-15T06:00:11.000Z (4 months ago)
• Last Synced: 2024-09-15T09:48:28.058Z (3 months ago)
• Language: Go
• Size: 81.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status](https://badge.buildkite.com/9884d4aae19682480e179efef95198c4db6fc1a26d9bcce22f.svg?branch=main)](https://buildkite.com/datum/fgax)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=datumforge_fgax&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=datumforge_fgax)

[![Go Report Card](https://goreportcard.com/badge/github.com/datumforge/fgax)](https://goreportcard.com/report/github.com/datumforge/fgax)

[![Go Reference](https://pkg.go.dev/badge/github.com/datumforge/fgax.svg)](https://pkg.go.dev/github.com/datumforge/fgax)

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)

# fgax

A go library for interacting with [OpenFGA](https://openfga.dev/) - it is comprised of 2 packages, `fgax` and `entfga`.

- fgax: wrapper to interact with the [OpenFGA go-sdk](https://github.com/openfga/go-sdk) and client libraries

- entfga: an [ent extension](https://entgo.io/docs/extensions/) to create relationship tuples using [ent Hooks](https://entgo.io/docs/hooks/)

## install

You can install `fgax` by running the following command:

```shell

go get github.com/datumforge/fgax@latest

```

## fgax

This package includes helper functions used heavily in [datum](https://github.com/datumforge/datum/).

For example, you can easily check for `Read` access of an organization using

```go

	// create client

	fgaClient, err := fgax.Client("https://fga-host.example.com")

	if err != nil {

		return false

	}

	// create access check

	req := fgax.AccessCheck{

		SubjectID:   "user-id",

		SubjectType: "user",

		ObjectID:    "organization-id",

	}

	allow, err := fgaClient.CheckOrgReadAccess(ctx, req)

	if err != nil {

		return false

	}

```

## entfga

See the [README](./entfga/README.md) for details

## Contributing

Please read the [contributing](.github/CONTRIBUTING.md) guide as well as the [Developer Certificate of Origin](https://developercertificate.org/). You will be required to sign all commits to the Datum project, so if you're unfamiliar with how to set that up, see [github's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).

## Security

We take the security of our software products and services seriously, including all of the open source code repositories managed through our Github Organizations, such as [datumforge](https://github.com/datumforge). If you believe you have found a security vulnerability in any of our repositories, please report it to us through coordinated disclosure.

**Please do NOT report security vulnerabilities through public github issues, discussions, or pull requests!**

Instead, please send an email to `[email protected]` with as much information as possible to best help us understand and resolve the issues. See the security policy attached to this repository for more details.

## Questions?

Open a github issue on this repository and we'll respond as soon as we're able!