linkorb / spicedb-php
SpiceDB connector for PHP
Installs: 1 316
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 1
Requires
- php: >=7.4
- symfony/http-client: ^5.4|^6.0
- symfony/property-access: ^5.4|^6.0
- symfony/serializer: ^5.4|^6.0
Requires (Dev)
- phpunit/phpunit: ^9.5
README
This repository houses the PHP client library for Authzed and SpiceDB.
SpiceDB is a database system for managing security-critical permissions checking.
SpiceDB acts as a centralized service that stores authorization data. Once stored, data can be performantly queried to answer questions such as "Does this user have access to this resource?" and "What are all the resources this user has access to?".
Authzed operates the globally available, serverless database platform for SpiceDB.
Supported client API versions:
You can find more info about the API in the Authzed Documentation API Reference or the Authzed API Buf Registry repository.
Getting Started
We highly recommend following the Protecting Your First App guide to learn the latest best practice to integrate an application with Authzed.
Basic Usage
Installation
Using composer tool run:
composer require linkorb/spicedb-php
Initializing a client
SpiceDB connector depends on symfony/serializer
and symfony/http-client
. Instantiation of a new client with pure PHP can be done following way:
use Symfony\Component\HttpClient\HttpClient; use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor; use Symfony\Component\Serializer\Encoder\JsonEncoder; use LinkORB\Authzed\Serializer\JsonLinesDecoder; use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer; use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer; use Symfony\Component\Serializer\Normalizer\ObjectNormalizer; use Symfony\Component\Serializer\Serializer; new SpiceDB( new Serializer( [new ArrayDenormalizer(), new UnwrappingDenormalizer(), new ObjectNormalizer(null, null, null, new ReflectionExtractor())], [new JsonEncoder(), new JsonLinesDecoder()] ), HttpClient::create(), getenv('SPICEDB_HOST'), getenv('SPICEDB_API_KEY') );
For Symfony apps there'll be a separate bundle which is currently WIP
Performing an API call
SpiceDB connector implements communication through REST API. Check LinkORB\Authzed\ConnectorInterface
for available methods. Here's example of write schema request:
$client->writeSchema(new \LinkORB\Authzed\Dto\Request\Schema( 'definition blog/post { relation reader: blog/user relation writer: blog/user permission read = reader + writer permission write = writer } definition blog/user {}' ));
Tests
Tests can be run with following command:
make run-test
For that you need to have Docker installed. Alternatively you can run test with PHP installed on host:
phpunit -c ./phpunit.xml --testsuite 'Integration' ./tests/