README
¶
postgresql-acl
acl Library
acl parses
PostgreSQL's ACL syntax
and returns a usable structure. Library documentation is available at
https://godoc.org/github.com/sean-/postgresql-acl.
package main
import (
"fmt"
"github.com/sean-/postgresql-acl"
)
func structToString() acl.ACL {
return acl.ACL{
Role: "foo",
GrantedBy: "bar",
Privileges: acl.Usage | acl.Create,
GrantOptions: acl.Create,
}
}
func stringToStruct() acl.Schema {
// Parse an aclitem string
aclitem, err := acl.Parse("foo=C*U/bar")
if err != nil {
panic(fmt.Sprintf("bad: %v", err))
}
// Verify that ACL permissions are appropriate for a schema type
schema, err := acl.NewSchema(aclitem)
if err != nil {
panic(fmt.Sprintf("bad: %v", err))
}
return schema
}
func main() {
fmt.Printf("ACL Struct to String: %+q\n", structToString().String())
fmt.Printf("ACL String to Struct: %#v\n", stringToStruct().String())
}
ACL Struct to String: "foo=UC*/bar"
ACL String to Struct: "foo=UC*/bar"
Supported PostgreSQL aclitem Types
- column permissions
- database
- domain
- foreign data wrappers
- foreign server
- function
- language
- large object
- schema
- sequences
- table
- table space
- type
Notes
The output from String() should match the ordering of characters in aclitem.
The target of each of these ACLs (e.g. schema name, table name, etc) is not
contained within PostgreSQLs aclitem and it is expected this value is managed
elsewhere in your object model.
Arrays of aclitem are supposed to be iterated over by the caller. For
example:
const schema = "public"
var name, owner string
var acls []string
err := conn.QueryRow("SELECT n.nspname, pg_catalog.pg_get_userbyid(n.nspowner), COALESCE(n.nspacl, '{}'::aclitem[])::TEXT[] FROM pg_catalog.pg_namespace n WHERE n.nspname = $1", schema).Scan(&name, &owner, pq.Array(&acls))
if err == nil {
for _, acl := range acls {
acl, err = pgacl.NewSchema(acl)
if err != nil {
return err
}
// ...
}
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACL ¶
type ACL struct {
Privileges Privileges
GrantOptions Privileges
Role string
GrantedBy string
}
ACL represents a single PostgreSQL `aclitem` entry.
func (ACL) GetGrantOption ¶
func (a ACL) GetGrantOption(priv Privileges) bool
GetGrantOption returns true if the acl has the grant option set for the specified priviledge.
func (ACL) GetPrivilege ¶
func (a ACL) GetPrivilege(priv Privileges) bool
GetPriviledge returns true if the acl has the specified priviledge set.
type Database ¶
type Database struct {
ACL
}
Database models the privileges of a database aclitem
func NewDatabase ¶
NewDatabase parses an ACL object and returns a Database object.
type ForeignDataWrapper ¶
type ForeignDataWrapper struct {
ACL
}
ForeignDataWrapper models the privileges of a domain aclitem
func NewForeignDataWrapper ¶
func NewForeignDataWrapper(acl ACL) (ForeignDataWrapper, error)
NewForeignDataWrapper parses an ACL object and returns a ForeignDataWrapper object.
type ForeignServer ¶
type ForeignServer struct {
ACL
}
ForeignServer models the privileges of a foreign server aclitem
func NewForeignServer ¶
func NewForeignServer(acl ACL) (ForeignServer, error)
NewForeignServer parses an ACL object and returns a ForeignServer object.
type Function ¶
type Function struct {
ACL
}
Function models the privileges of a function aclitem
func NewFunction ¶
NewFunction parses an ACL object and returns a Function object.
type Language ¶
type Language struct {
ACL
}
Language models the privileges of a language aclitem
func NewLanguage ¶
NewLanguage parses an ACL object and returns a Language object.
type LargeObject ¶
type LargeObject struct {
ACL
}
LargeObject models the privileges of a large object aclitem
func NewLargeObject ¶
func NewLargeObject(acl ACL) (LargeObject, error)
NewLargeObject parses an ACL object and returns a LargeObject object.
type Privileges ¶
type Privileges uint16
Privileges represents a PostgreSQL ACL bitmask
const ( NoPrivs Privileges = 0 // Ordering taken from postgresql/src/include/nodes/parsenodes.h Insert Privileges = 1 << iota Select Update Delete Truncate References Trigger Execute Usage Create Temporary Connect )
See postgresql/src/include/utils/acl.h for inspiration. Like PostgreSQL, "rights" refer to the combined grant option and privilege bits fields.
type Schema ¶
type Schema struct {
ACL
}
Schema models the privileges of a schema aclitem
func (Schema) Grants ¶
Grants returns a list of SQL queries that constitute the privileges specified in the receiver for the target schema.
type Sequence ¶
type Sequence struct {
ACL
}
Sequence models the privileges of a sequence aclitem
func NewSequence ¶
NewSequence parses a PostgreSQL ACL string for a sequence and returns a Sequence object
type Tablespace ¶
type Tablespace struct {
ACL
}
Tablespace models the privileges of a tablespace aclitem
func NewTablespace ¶
func NewTablespace(acl ACL) (Tablespace, error)
NewTablespace parses an ACL object and returns a Tablespace object.
Source Files