59b44b60df
This ended up being wayyyy more complicated than expected due to issues with Hibernate, various dependencies having conflicts with the proto dependency version, and other breaking changes. Notes: - Hibernate 7 switches up the user type / converter system and for us, this means we must be / want to be more explicit with how we convert and store things. For example, we need to add Postgres types to @Column definitions. - Hibernate 7.3 has an issue with generic MappedSuperclasses -- we have issues with BaseDomainLabelList. I'll investigate that, but for now let's stick with 7.2.x - H7 is more strict with annotations and prevents us from storing mapped superclasses embedded within other objects. This kinda makes sense but makes the History objects a bit more difficult. We had to add "concrete" embeddable DomainBase and HostBase objects that we can store/retrieve from the DB. - We convert some of the calls to "Query" to "TypedQuery" -- in Hibernate 8 / JPA 4.0 these will be super-deprecated and we'll need to shift everything over, so this is necessary. - You aren't supposed to put callback listeners on embedded entities (because it can be not obvious what's happening). We don't like that, so we add our own annotations that are processed recursively for embedded entities, so we get things like the update / create timestamps. - Hibernate doesn't allow for multiple converters to be auto-applied to the same "type" and it counts all VKey converters as one type. Unfortunately, this means we have to explicitly mark each one. - A bunch of other dependency changes were required to keep from having the proto 3/4 conflict
Nomulus
| Internal Build | FOSS Build | License | Code Search |
|---|---|---|---|
 |
 |
 |
 |
Overview
Nomulus is an open source, scalable, cloud-based service for operating top-level domains (TLDs). It is the authoritative source for the TLDs that it runs, meaning that it is responsible for tracking domain name ownership and handling registrations, renewals, availability checks, and WHOIS requests. End-user registrants (i.e., people or companies that want to register a domain name) use an intermediate domain name registrar acting on their behalf to interact with the registry.
Nomulus runs on Google Kubernetes Engine and is written primarily in Java. It is the software that Google Registry uses to operate TLDs such as .google, .app, .how, .soy, and .みんな. It can run any number of TLDs in a single shared registry system using horizontal scaling. Its source code is publicly available in this repository under the Apache 2.0 free and open source license.
Getting started
The following resources provide information on getting the code and setting up a running system:
- Install guide
- View the source code for the Main HTTP server and for the EPP proxy
- Other docs
- Javadoc
- Nomulus discussion group, for any other questions
If you are thinking about running a production registry service using our platform, please drop by the user group and introduce yourself and your use case. To report issues or make contributions, use GitHub issues and pull requests.
Capabilities
Nomulus has the following capabilities:
- Extensible Provisioning Protocol (EPP): An XML protocol that is the standard format for communication between registrars and registries. It includes operations for registering, renewing, checking, updating, and transferring domain names.
- DNS interface: The registry provides a pluggable interface that can be implemented to handle different DNS providers. It includes a sample implementation using Google Cloud DNS, as well as an RFC 2136 compliant implementation that works with BIND. If you are using Google Cloud DNS, you may need to understand its capabilities and provide your own multi-AS solution.
- Registration Data Access Protocol (RDAP): A JSON API that returns structured, machine-readable information about domain name ownership. It is essentially a newer version of WHOIS.
- Registry Data Escrow (RDE): A daily export of all ownership information for a TLD to a third party escrow provider to allow take-over by another registry operator in the event of serious failure. This is required by ICANN for all new gTLDs.
- Premium pricing: Communicates prices for premium domain names (i.e., those that are highly desirable) and supports configurable premium registration and renewal prices. An extensible interface allows fully programmatic pricing.
- Billing history: A full history of all billable events is recorded, suitable for ingestion into an invoicing system.
- Registration periods: Qualified Launch Partner, Sunrise, Landrush, Claims, and General Availability periods of the standard gTLD lifecycle are all supported.
- Brand protection for trademark holders (via TMCH): Allows rights-holders to protect their brands by blocking registration of domains using their trademark. This is required by ICANN for all new gTLDs.
- Registrar support console: A self-service web console that registrars can use to manage their accounts in the registry system.
- Reporting: Support for required external reporting (such as ICANN monthly registry reports, CZDS, Billing and Registration Activity) as well as internal reporting using BigQuery.
- Administrative tool: Performs the full range of administrative tasks needed to manage a running registry system, including creating and configuring new TLDs.
- Secure storage of cryptographic keys: A keyring interface is provided for plugging in your own implementation (see configuration doc for details), and an implementation based on Google Cloud Secret Manager is available.
- TPC Proxy: Nomulus is built on top of the Jetty container that implements the Jakarta Servlet specification and only serves HTTP/S traffic. A proxy to translate raw TCP traffic (e.g., EPP) to and from HTTP is provided. Instructions on setting up the proxy are available. The proxy can either run in a separate cluster and communicate to Nomulus public HTTP endpoints via the Internet, or as a sidecar with the Nomulus image in the same pod and communicate to it via loopback.
Additional components
Registry operators interested in deploying Nomulus will likely require some additional components that need to be configured separately.
-
A way to invoice registrars for domain name registrations and accept payments. Nomulus records the information required to generate invoices in billing events.
-
Fully automated reporting to meet ICANN's requirements for gTLDs. Nomulus includes substantial reporting functionality, but some additional work will be required by the operator in this area.
-
System status and uptime monitoring.
Outside references
- Identity Digital has helped review the code and provided valuable feedback.
- CoCCa and FRED are other open-source registry platforms in use by many TLDs.
- We are not aware of any fully open source domain registrar projects, but open source EPP Toolkits (not yet tested with Nomulus; may require integration work) include:
- Some Open Source DNS Projects that may be useful, but which we have not tested: