Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ojkelly/bunjil
A GraphQL bastion server with schema merging, authentication and authorization with Policy Based Access Control
https://github.com/ojkelly/bunjil
authentication authorization bastion graphql graphql-server koa prisma public-server wahn
Last synced: about 2 months ago
JSON representation
A GraphQL bastion server with schema merging, authentication and authorization with Policy Based Access Control
- Host: GitHub
- URL: https://github.com/ojkelly/bunjil
- Owner: ojkelly
- License: mit
- Archived: true
- Created: 2018-02-13T07:17:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-19T11:54:23.000Z (over 5 years ago)
- Last Synced: 2024-09-26T00:56:22.986Z (about 2 months ago)
- Topics: authentication, authorization, bastion, graphql, graphql-server, koa, prisma, public-server, wahn
- Language: TypeScript
- Homepage: https://bunjil.js.org
- Size: 1.66 MB
- Stars: 25
- Watchers: 0
- Forks: 5
- Open Issues: 28
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Bunjil
[](https://npmjs.org/package/bunjil)
[](https://npmjs.org/package/bunjil)
[](https://david-dm.org/ojkelly/bunjil)
[](https://travis-ci.org/ojkelly/bunjil)
[](https://codecov.io/gh/ojkelly/bunjil)
[](https://nodesecurity.io/orgs/ojkelly/projects/7f441bdb-76ab-4155-aec9-00777b5adc9a)[](https://snyk.io/test/npm/bunjil)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fojkelly%2Fbunjil?ref=badge_shield)
[bunjil.js.org](https://bunjil.js.org) | [Getting Started](https://bunjil.js.org/docs/getting-started)
Bunjil is a public facing GraphQL server.
It comes with Policy Based authorization, and hook for your own authentication (Passport.js, Auth0, database).
It’s purpose is to allow the stitching of one or more private GraphQL Schemas into a public one.
# Roadmap
* [x] Documentation
* [x] Merge multiple GraphQL schemas into one public schema
* [ ] Ability to hide Types
* [ ] Ability to hide fields (masking)
* [x] Policy based authorization down to the field/edge level
* [x] Ability to deny access to fields based on roles with a policy
* [x] Caching, and caching policies down to the field level
* [x] Authentication hook
* [x] Authorization hook
## Getting Started
`yarn add bunjil`
`npm install bunjil`
```typescript
// Import Bunjil and the Policy Types
import { Bunjil, Policy, PolicyCondition, PolicyEffect } from "bunjil";
// Create a schema
const typeDefs: string = `
type User {
id: ID
name: String
password: String
posts(limit: Int): [Post]
}
type Post {
id: ID
title: String
views: Int
author: User
}
type Query {
author(id: ID): User
topPosts(limit: Int): [Post]
}
`;
// Resolvers are not shown in this example.
const schema = makeExecutableSchema({
typeDefs,
resolvers,
});
// Create a simple policy allowing public access to the data
const policies: Policy[] = [
{
id: "public:read-all",
resources: ["Query::topPosts", "Post::*", "User::*"],
actions: ["query"],
effect: PolicyEffect.Allow,
roles: ["*"],
},
{
// Explicitly deny access to the password field.
// This will superseed any other policy
id: "deny:user::password",
resources: ["User::password"],
actions: ["query"],
effect: PolicyEffect.Deny,
roles: ["*"],
},
];
// Create our bunjil server
const bunjil: Bunjil = new Bunjil({
// Server config
server: {
port: 3000,
tracing: true,
cacheControl: true,
},
// Optionally in DEV you can enable the GraphQL playground
playgroundOptions: {
enabled: false,
},
// Set the endpoints where GraphQL is available at
endpoints: {
graphQL: "/graphql",
subscriptions: "/graphql/subscriptions",
playground: "/playground",
},
policies,
});
// Add our schema to the Bunjil instance
bunjil.addSchema({ schemas: [schema] });
// Now start Bunjil
await bunjil.start();
```
### Usage
## Running the tests
Use `yarn test` or `npm run test`.
Tests are written with `ava`, and we would strongly like tests with any new functionality.
## Contributing
Please read [CONTRIBUTING.md](https://github.com/ojkelly/bunjil/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ojkelly/bunjil/tags).
## Authors
* **Owen Kelly** - [ojkelly](https://github.com/ojkelly)
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fojkelly%2Fbunjil?ref=badge_large)
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/ojkelly/bunjil/LICENSE.md) file for details
## Acknowledgments
* [Behind the name](https://en.wikipedia.org/wiki/Bunjil)