kit-lang/packages/kit-policyUm framework de autorização flexível e componível para Kit (inspirado pelo Action Policy)
Um framework de autorização flexível e componível para Kit, inspirado no Action Policy do Ruby.
[TOC]
| Arquivo | Descrição |
|---|---|
.editorconfig | Configuração de formatação do editor |
.gitignore | Regras de ignorar do Git para artefatos de build e dependências |
.tool-versions | Versões de ferramentas asdf (Zig, Kit) |
LICENSE | Arquivo de licença MIT |
README.md | Este arquivo |
examples/blog-policy.kit | Exemplo de autorização de blog |
kit.toml | Manifesto do pacote com metadados, tarefas e configuração de lint |
src/core.kit | Auxiliares principais de autorização |
src/error.kit | Erros de autorização, tipos de resultado e motivos de falha |
src/main.kit | Módulo raiz do pacote |
src/scope.kit | Auxiliares de escopo, predicado e paginação |
tests/policy.test.kit |
Nenhuma dependência de pacote Kit.
kit add gitlab.com/kit-lang/packages/kit-policy.git
import Kit.Policy.Core as PolicyCore
import Kit.Policy.Error as PolicyError
import Kit.Policy.Scope as PolicyScope
type Post = {id: Int, author-id: Int, published?: Bool, title: String}
type User = {id: Int, admin?: Bool}
type AuthContext = {user: User}
post-policy = fn(post, ctx, action) =>
if ctx.user.admin? then
PolicyCore.allow
else
match PolicyCore.resolve-alias action
| :show -> PolicyCore.allow-if post.published?
| :update -> PolicyCore.allow-if (ctx.user.id == post.author-id)
| :destroy -> PolicyCore.allow-if (ctx.user.id == post.author-id)
| _ -> PolicyCore.no-rule action
post-scope = fn(posts, ctx) =>
if ctx.user.admin? then
posts
else
posts |>> List.filter (fn(post) => post.published?)
main = fn =>
user = {id: 1, admin?: false}
ctx = {user: user}
post = {id: 1, author-id: 1, published?: true, title: "Hello"}
posts = [post]
if PolicyCore.can-with? post-policy post ctx :update then
println "Can update post"
else
println "Cannot update post"
visible-posts = PolicyScope.scope-with post-scope posts ctx
page = PolicyScope.paginate 1 10 visible-posts
info = PolicyScope.pagination-info 1 10 visible-posts
println "Visible posts: ${page}"
println "Pages: ${info.pages}"
err = PolicyError.not-authorized "Post" :update "not the author"
println (PolicyError.message err)
main
Auxiliares principais para funções de política que retornam Result Bool PolicyError.
PolicyCore.can-with? policy resource context action
PolicyCore.may-with? policy resource context action
PolicyCore.allow
PolicyCore.deny
PolicyCore.allow-if condition
PolicyCore.deny-if condition
PolicyCore.no-rule action
PolicyCore.allow-or-deny condition resource-name reason action
Auxiliares de pré-verificação retornam Option Bool: Some true permite, Some false nega e None continua para a regra principal.
PolicyCore.admin-bypass is-admin? ctx
PolicyCore.owner-check is-owner? resource ctx
PolicyCore.first-pre-check [check1, check2, check3]
Auxiliares de ação fornecem grupos de ação comuns e aliases.
PolicyCore.crud-actions
PolicyCore.read-actions
PolicyCore.write-actions
PolicyCore.read-action? action
PolicyCore.write-action? action
PolicyCore.resolve-alias :new # :create
PolicyCore.resolve-alias :edit # :update
PolicyCore.resolve-alias :delete # :destroy
PolicyCore.resolve-alias :view # :show
Auxiliares de composição de política combinam vários resultados de autorização.
PolicyCore.all-allowed? [result1, result2, result3]
PolicyCore.any-allowed? [result1, result2, result3]
Auxiliares de escopo filtram coleções antes de retornar dados para um chamador.
PolicyScope.scope-with scope-fn items ctx
PolicyScope.filter-by predicate items
PolicyScope.is-owned-by? get-owner-id get-user-id item ctx
PolicyScope.is-published? get-published item
PolicyScope.is-in-state? get-state target-state item
PolicyScope.is-admin-or? check-admin fallback-check ctx item
Combinadores de predicado são úteis para construir verificações de escopo reutilizáveis.
PolicyScope.both? pred1 pred2 item
PolicyScope.either? pred1 pred2 item
PolicyScope.not-matching? pred item
Auxiliares de paginação são indexados a partir de 1.
page1 = PolicyScope.paginate 1 10 items
pages = PolicyScope.total-pages 10 items
info = PolicyScope.pagination-info 1 10 items
Tipos de erro e resultado para falhas de autorização.
type PolicyError =
| NotAuthorized {resource: String, action: Keyword, reason: String}
| RuleNotFound {action: Keyword}
| ContextMissing {field: String}
| PolicyNotFound {resource-type: String}
| CustomError String
type FailureReason = FailureReason {
policy: String,
action: Keyword,
details: String
}
type AuthResult =
| Allowed
| Denied String
Funções auxiliares são exportadas do módulo, portanto, quando importadas como PolicyError, são chamadas como funções do módulo.
PolicyError.not-authorized resource action reason
PolicyError.rule-not-found action
PolicyError.context-missing field
PolicyError.policy-not-found resource-type
PolicyError.custom message
PolicyError.message err
PolicyError.kind err
PolicyError.is-not-authorized? err
PolicyError.is-rule-not-found? err
PolicyError.new policy action
PolicyError.with-details policy action details
PolicyError.policy reason
PolicyError.action reason
PolicyError.details reason
PolicyError.format reason
PolicyError.allowed
PolicyError.denied reason
PolicyError.is-allowed? result
PolicyError.is-denied? result
PolicyError.reason result
PolicyError.to-result resource-name action result
Result Bool PolicyError em vez de lançar exceções.:index, :show, :create, :update e :destroy.Execute o exemplo de política de blog com o interpretador:
kit run examples/blog-policy.kit
Compile o exemplo para um binário nativo:
kit build examples/blog-policy.kit && ./blog-policy
Execute a suíte de testes:
kit test
Execute a suíte de testes com cobertura:
kit test --coverage
Execute o fluxo de desenvolvimento padrão (formatar, verificar, testar):
kit dev
Isso irá:
src/examples/tests/ com coberturaExecute verificações de paridade para os exemplos:
kit parity --failures-only
Gere documentação da API a partir de comentários de documentação:
kit doc
Nota: Fontes Kit com comentários de documentação (##) gerarão documentos HTML em docs/*.html.
Remova arquivos gerados, caches e artefatos de build:
kit task clean
Nota: Definido em kit.toml.
Para instalar este pacote localmente para desenvolvimento:
kit install
Isso instala o pacote em ~/.kit/packages/@kit/policy/, tornando-o disponível para importação como Kit.Policy em outros projetos.
Este pacote é distribuído sob a licença MIT - veja LICENSE para detalhes.
| Testes de comportamento de política de ponta a ponta |
tests/types.test.kit | Testes de tipos e auxiliares de política |