https://github.com/adaptant-labs/opa-api-authz-dart
Open Policy Agent-based API Authorization in Dart
https://github.com/adaptant-labs/opa-api-authz-dart
api-authentication authz dart dart2 dartlang opa openpolicyagent
Last synced: 11 months ago
JSON representation
Open Policy Agent-based API Authorization in Dart
- Host: GitHub
- URL: https://github.com/adaptant-labs/opa-api-authz-dart
- Owner: adaptant-labs
- License: apache-2.0
- Created: 2019-10-13T21:04:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T23:46:46.000Z (over 6 years ago)
- Last Synced: 2025-01-30T12:28:08.509Z (over 1 year ago)
- Topics: api-authentication, authz, dart, dart2, dartlang, opa, openpolicyagent
- Language: Dart
- Size: 42 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
#  OPA API Authorization in Dart Example
This repository shows how to integrate a service written in Dart with [OPA](http://www.openpolicyagent.org) to perform
API authorization. It is a direct port of the [OPA-Python](https://github.com/open-policy-agent/example-api-authz-python)
example, with a few enhancements.
## Trying the example
This example utilizes an independent OPA server which must already be running, and which must allow new policies to be
uploaded. An existing OPA server URI can be defined in the `OPA_URL` environment variable, which otherwise defaults to
a local instance at `http://localhost:8181`.
To run the OPA instance locally:
```bash
$ opa run -s
```
note that the example policy (in the `./policies` directory) will be uploaded to the OPA server by the application
directly. Any additional policies with the `.rego` extension found in this directory will similarly be uploaded to the
OPA server on start.
Run the server:
```bash
$ dart bin/server.dart
```
Without authorization, view a list of cars:
```bash
$ curl -X GET localhost:8080/cars
```
As someone with the manager role, create a car (this should be allowed):
```bash
$ curl -H 'Authorization: alice' -H 'Content-Type: application/json' \
-X PUT localhost:8080/cars/test-car \
-d '{"model": "Toyota", "vehicle_id": "357192", "owner_id": "4821", "id": "test-car"}'
```
As someone with the car admin role, try to delete a car (this should be denied):
```bash
$ curl -H 'Authorization: kelly' \
-X DELETE localhost:8080/cars/test-car
```
## Running from Docker
To run from Docker, simply specify the host and port of the OPA server through
the passed in `OPA_URL` environment variable:
```bash
$ docker run -e OPA_URL='opa:8181' -p 8080:8080 adaptant/opa-api-authz-dart
```
Note that by default the Docker image enables the Dart Observatory, which binds
port 8181 within the container by default. If using `--net=host`, the default
Observatory port needs to be shifted out of the way. This can be done by
tweaking the `DART_VM_OPTIONS`, as so:
```bash
$ docker run -e DART_VM_OPTIONS='--enable-vm-service=8282' --net=host adaptant/opa-api-authz-dart:latest
Starting Dart with additional options --enable-vm-service=8282
Observatory listening on http://127.0.0.1:8282/4y7welzb8Fc=/
Applying policy: ./policies/example.rego
Example Service listening on 0.0.0.0:8080
...
```
## Features and bugs
Please file feature requests and bugs at the [issue tracker][tracker].
[tracker]: https://github.com/adaptant-labs/opa-api-authz-dart/issues
## License
Licensed under the terms of the Apache 2.0 license (the license under which the `OPA-Python` example was released),
the full version of which can be found in the [LICENSE](LICENSE)
file included in this distribution.
## Acknowledgements
- Derived from [example-api-authz-python](https://github.com/open-policy-agent/example-api-authz-python) by [@tsandall](https://github.com/tsandall).