circuithub / oso

Haskell bindings to the Polar query engine and Oso authorization library

Haskell bindings to polar

This library contains Haskell bindings to the Polar query engine, and provides an API for the Oso authorization library.

Example

module Main where

import Control.Exception
import Oso


-- Define ordinary Haskell types, deriving PolarValue to allow them to be used
-- with Polar.
newtype User = User
  { roles :: [Role]
  }
  deriving stock (Eq, Generic, Show)
  deriving PolarValue via GenericPolarRecord User


data Role = Role
  { name :: Text
  , resource :: Organization
  }
  deriving stock (Eq, Generic, Show)
  deriving PolarValue via GenericPolarRecord Role


data Repository = Repository
  { name :: Text
  , organization :: Organization
  }
  deriving stock (Eq, Generic, Show)
  deriving PolarValue via GenericPolarRecord Repository


newtype Organization = Organization
  { name :: Text }
  deriving stock (Eq, Generic, Show)
  deriving PolarValue via GenericPolarRecord Repository


main :: IO ()
main = do
  -- Create a new handle to the Polar query engine.
  oso <- newOso

  -- Register any types used for RBAC
  registerType @User oso
  registerType @Role oso
  registerType @Repository oso
  registerType @Organization oso

  -- Load the policy.polar file
  expect =<< loadFiles oso ["policy.polar"]

  -- Fetch data needed for authorization. For this example we'll just construct
  -- some test values.
  let circuitHub = Organization{ name = "CircuitHub" }
  let oso        = Organization{ name = "oso" }

  let ourRepository = Repository{ name = "circuithub", organization = circuitHub }
  let chRepository  = Repository{ name = "circuithub", organization = circuitHub }
  let osoRepository = Repository{ name = "oso", organization = oso }

  let chUser = User{ roles = [ Role{ name = "owner", resource = circuitHub } ] }

  -- Run some queries!
  isAllowed oso chUser "read" chRepository  -- True

  isAllowed oso chUser "read" osoRepository -- False


expect :: Exception e => Either e a -> IO a
expect = either throw pure

oso's Issues

Licensing question

Hello!

I just wanted to know: does this Haskell library have any license?

At first, I was interested in using it but there was some features that existed in the other client libraries (Ruby, JS...) that were missing here (e.g. data filtering). Also, compiling the library automatically required some doing (compile the Oso API library and link with it).

I played with the code just to see what could be done (implemented some of the features I wanted to test, ease the compilation process...). But since there is no official license for the library (though Oso is Apache-2 licensed), I don't think I can do anything with that experiment.

So I was wondering what the project's license was and what it allowed me to do with it.

Thanks in any case 🙂