Authorization module for Fonoster
npm install @fonoster/authzauthz
=================
Authz is a simple and extensible authorization module for Fonoster. It provides a way to authorize incoming phone and API calls.
The module has a simple interface that allows you to create authorization strategies. That includes verifying if a session is authorized, if a GRPC method is authorized, charging an account, and getting the account balance.
The interface is defined as follows:
``typescript`
type AuthzHandler = {
checkSessionAuthorized(request: VoiceRequest): Promise
checkMethodAuthorized(
request: CheckMethodAuthorizedRequest
): Promise
addBillingMeterEvent(request: AddBillingMeterEventRequest): Promise
};
Please look at the DummyAuthzHandler for an example of implementing your authorization strategy.
To enable the Authz module you need to set the AUTHZ_SERVICE_ENABLED environment variable to true. Also, you need the AUTHZ_SERVICE_HOST (required), AUTHZ_SERVICE_PORT (defaults), and AUTHZ_SERVICE_METHODS (default is /fonoster.calls.v1beta2.Calls/CreateCall) environment variables.
Imagine you want to authorize the creation of new Workspaces. You can add the /fonoster.identity.v1beta2.Identity/CreateWorkspace method to the AUTHZ_SERVICE_METHODS environment variable and implement the checkMethodAuthorized` method in your AuthzHandler.