https://github.com/segrax/opa-php-examples

Example usage of OPA in PHP
https://github.com/segrax/opa-php-examples

authorization authorization-middleware middlewares opa openpolicyagent psr-15 psr-7 slimphp

Last synced: about 1 month ago
JSON representation

Example usage of OPA in PHP

• Host: GitHub
• URL: https://github.com/segrax/opa-php-examples
• Owner: segrax
• License: mit
• Created: 2019-12-07T00:38:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-19T21:17:03.000Z (almost 2 years ago)
• Last Synced: 2024-07-30T20:05:19.599Z (6 months ago)
• Topics: authorization, authorization-middleware, middlewares, opa, openpolicyagent, psr-15, psr-7, slimphp
• Language: PHP
• Size: 94.7 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# segrax/opa-php-examples

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)

[![Build Status](https://api.travis-ci.com/segrax/opa-php-examples.svg)](https://travis-ci.com/segrax/openpolicyagent)

Examples of using Open Policy Agent (OPA) with the [segrax/open-policy-agent](https://github.com/segrax/openpolicyagent) library on PHP 7.3.

These examples are pre-configured to work out of the box and contain insecure JWTs / secret-key and must never be reused for any purpose.

The API is setup for xdebug including working [@code](https://code.visualstudio.com/) configuration.

All Examples make use of docker-compose, and executing the steps below will launch multiple contains.

For a walkthrough using these examples please see this [tutorial](https://coil.com/p/segra/OPA-for-API-Authorization-with-Slim-PHP/H-7YsQL2m)

## Includes

* Plain PHP usage of client

* Slim 4 Skeleton API with policy authorization

## Usage

### Plain PHP

This example can be used for making queries to an instance of OPA.

```bash

    cd plain

    make composer-install

    make test

```

### Slim 4 API Authorization

This example demonstrates how to invoke a policy for making a decision on access to a route.

```bash

    cd slim4-api

    make start

```

The containers will now build and be started, by default the API will be listening on port 80.

This example serves up policies in a bundle to the running OPA using the Distributor PSR-15 middleware that is included in segrax/open-policy-agent.

A [Postman](https://www.getpostman.com/) collection is included inside slim4-api, import it and test both endpoints.

This is the policy for the included example endpoint.

```

package slim.api

default allow = false

# OPA Bundle

allow {

    input.path = ["opa", "bundles", "{name}"]

    input.token.sub == "opa"

}

# Allow a user to access their own private end point

allow {

    input.method == "GET"

    input.path = ["welcome", userid ]

    userid == input.token.sub

}

# Allow anyone (including unauthed) access to the public endpoint

allow {

    input.path = ["public"]

    input.method == "GET"

}

```