OmniEIR

OmniEIR is the 5G Equipment Identity Register (5G-EIR) for the Omnitouch 5G Core. It answers a single question for the AMF during registration: is this device's equipment identity (PEI/IMEI) whitelisted, blacklisted, or greylisted? This lets the operator deny service to stolen or barred handsets and enforce regulatory IMEI checks.

The 5G-EIR is defined by 3GPP TS 23.501 §6.2.16; the AMF invokes it during registration per 3GPP TS 23.502 §4.2.2.2, and the N5g-eir_EquipmentIdentityCheck service is specified in 3GPP TS 29.511.

OmniEIR holds no device database of its own, by design. The operator's IMEI allow/block/grey rules are provisioned in OmniHSS (the same eir_rule store that backs the 4G S13 interface), and OmniEIR reads them over the HSS REST API and applies the identical matching logic, so a device barred on 4G is barred on 5G with one rule set. Terminate TLS at an external proxy in front of the SBI listener.

Documentation

• Operations Guide - Architecture, the equipment-check flow, endpoints, and day-to-day operation
• Configuration Reference - Every configuration key and environment variable
• Metrics and Monitoring - What is observable today (structured logs and telemetry)
• Troubleshooting - Common issues and their resolutions

Architecture Overview

OmniEIR sits between the AMF (which asks) and OmniHSS (which holds the operator's rules). It registers with the NRF as NFType 5G_EIR so the AMF can discover it.

The verdict maps directly from the OmniHSS rule action to the 5G EquipmentStatus:

OmniHSS rule action	5G EquipmentStatus	AMF behaviour
whitelist	WHITELISTED	Registration proceeds
greylist	GREYLISTED	Registration proceeds (device is tracked, not barred)
blacklist	BLACKLISTED	Registration rejected: 5GMM cause #5 "PEI not accepted"
(no rule matches)	configured default (WHITELISTED)	Per default

Features Overview

Core Functionality

• N5g-eir_EquipmentIdentityCheck (Get) - GET /n5g-eir-eic/v1/equipment-status?pei={pei}&supi={supi} returning EirResponseData (TS 29.511).
• HSS-backed decisions - Reads the operator's eir_rule set from OmniHSS (GET /api/eir/rule); no separate provisioning surface.
• Spec-faithful matching - Mirrors the 4G equipment-check order (IMEISV → IMEI → IMSI, first regex match wins), so one rule set governs 4G and 5G alike.
• Configurable unknown-equipment behaviour - Fail-open (WHITELISTED) by default, matching the HSS; can be set to BLACKLISTED for a fail-closed deployment.

Integration Points

• AMF (N5g-eir) - Queries OmniEIR during registration and acts on the verdict.
• OmniHSS (REST) - The source of truth for IMEI allow/block/grey rules.
• NRF (SBI) - OmniEIR registers as NFType 5G_EIR and heartbeats.

Configuration Summary

All configuration lives under the :omnieir application key.

config :omnieir,
  sbi_scheme: "http",
  sbi_addr: "127.0.0.23",
  sbi_port: 7777,
  nrf_uri: "http://127.0.0.10:7777",
  mcc: "999",
  mnc: "70",
  heartbeat_interval: 10_000,
  hss_api_base_url: "https://127.0.0.1:8443",
  hss_api_key: "<OmniHSS API key with role eir_lookup>",
  unknown_equipment_status: "WHITELISTED"

See the Configuration Reference for the complete parameter tables and the AMF-side keys (eir_enabled, eir_uri) that turn the check on.