regorus/docs/builtins.md

Built-in Functions

This page lists all the supported Rego built-in functions and the cargo feature that is needed to enable each builtin.

Those builtins that are not need for a specific use of the Regorus crate can be excluded from the binary by not specifying the corresponding feature. This is useful in Confidential Computing scenarios where

• There needs to be control over what a policy execution can and cannot do.
• There needs to be control over exactly what goes into the Trusted Computing Base.

Currently many builtins are baked-in, i.e. there is no way to exclude them from the TCB. In future, each builtin will be associated with a feature (many builtins could be associated with the same feature).

• Comparison

  Builtin	Feature
  x == y	_
  x > y	_
  x >= y	_
  x < y	_
  x <= y	_
  x != y	_

• Numbers

  Builtin	Feature
  abs	_
  ceil	_
  x / y	_
  floor	_
  x - y	_
  x * y	_
  numbers.range	_
  numbers.range_step	_
  x + y	_
  rand.intn	_
  x % y	_
  round	_

• Aggregates

  Builtin	Feature
  count	_
  max	_
  min	_
  product	_
  sort	_
  sum	_

• Arrays

  Builtin	Feature
  array.concat	_
  array.reverse	_
  array.slice	_

• Sets

  Builtin	Feature
  x & y	_
  intersection	_
  x - y	_
  x | y	_
  union	_

• Objects

  Builtin	Feature
  json.filter	_
  json.match_schema	jsonschema
  json.remove	_
  json.verify_schema	jsonschema
  object.filter	_
  object.get	_
  object.keys	_
  object.remove	_
  object.subset	_
  object.union	_
  object.union_n	_

• Strings

  Builtin	Feature
  concat	_
  contains	_
  endswith	_
  format_int	_
  indexof	_
  indexof_n	_
  lower	_
  replace	_
  split	_
  sprintf	_
  startswith	_
  strings.any_prefix_match	_
  strings.any_suffix_match	_
  strings.render_template	_
  strings.replace_n	_
  strings.reverse	_
  substring	_
  trim	_
  trim_left	_
  trim_prefix	_
  trim_right	_
  trim_space	_
  trim_suffix	_
  upper	_

• Regex

  Builtin	Feature
  regex.find_all_string_submatch_n	regex
  regex.find_n	regex
  regex.globs_match	regex
  regex.is_valid	regex
  regex.match	regex
  regex.replace	regex
  regex.split	regex
  regex.template_match	regex

• Glob

  Builtin	Feature
  glob.match	glob
  glob.quote_meta	glob

• Bitwise

  Builtin	Feature
  bits.and	_
  bits.lsh	_
  bits.negate	_
  bits.or	_
  bits.rsh	_
  bits.xor	_

• Conversions

  Builtin	Feature
  to_number	_

• Units

  Builtin	Feature
  units.parse	_
  units.parse_bytes	_

• Types

  Builtin	Feature
  is_array	_
  is_boolean	_
  is_null	_
  is_number	_
  is_object	_
  is_set	_
  is_string	_
  type_name	_

• Encoding

  Builtin	Feature
  base64.is_valid	base64
  base64url.decode	base64
  base64url.encode	base64url
  base64url.encode_no_pad	base64url
  hex.decode	hex
  hex.encode	hex
  json.is_valid	_
  json.marshal	_
  json.marshal_with_options	_
  json.unmarshal	_
  urlquery.decode	urlquery
  urlquery.decode_object	urlquery
  urlquery.encode	urlquery
  urlquery.encode_object	urlquery
  yaml.is_valid	yaml
  yaml.marshal	yaml
  yaml.unmarshal	yaml

• Time

  Builtin	Feature
  (time.add_date	time
  time.add_date	time
  time.clock	time
  time.date	time
  time.diff	time
  time.format	time
  time.now_ns	time
  time.parse_duration_ns	time
  time.parse_ns	time
  time.parse_rfc3339_ns	time
  time.weekday	time

• Cryptography

  Builtin	Feature
  crypto.hmac.equal	crypto
  crypto.hmac.md5	crypto
  crypto.hmac.sha1	crypto
  crypto.hmac.sha256	crypto
  crypto.hmac.sha512	crypto
  crypto.md5	crypto
  crypto.sha1	crypto
  crypto.sha256	crypto

• Graphs

  Builtin	Feature
  graph.reachable	graph
  walk	graph

• UUID

  Builtin	Feature
  uuid.parse	uuid
  uuid.rfc4122	uuid

• Semantic Versions

  Builtin	Feature
  semver.compare	semver
  semver.is_valid	semver

• [OPA](https://www.openpolicyagent.org/docs/latest/policy-reference/#opa

  Builtin	Feature
  opa.runtime	_

• Debugging

  Builtin	Feature
  print(...)	_

• Tracing

  Builtin	Feature
  trace	_