RDAP: Use IANA identifier as the registrar handle

According to the ICAAN operation profile:

2.1.7. Registries MUST support lookup for entities with the registrar role within other objects using the handle (as described in 3.1.5 of RFC7482). The handle of the entity with the registrar role MUST be equal to IANA Registrar ID. The entity with the registrar role in the RDAP response MUST contain a publicIDs member to identify the IANA Registrar ID from the IANA’s Registrar ID registry. The type value of the publicID object MUST be equal to IANA Registrar ID.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=130452501

java/google/registry/model/registrar/Registrar.java

@@ -286,6 +286,7 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
    * </ul>
    * @see "http://www.iana.org/assignments/registrar-ids/registrar-ids.txt"
    */
+  @Index
   Long ianaIdentifier;
 
   /** Identifier of registrar used in external billing system (e.g. Oracle). */
@@ -840,6 +841,29 @@ public class Registrar extends ImmutableObject implements Buildable, Jsonifiable
       }});
   }
 
+  /**
+   * Load registrar entities by IANA identifier range outside of a transaction.
+   *
+   * @param ianaIdentifierStart returned registrars will have an IANA id greater than or equal to
+   *        this
+   * @param ianaIdentifierAfterEnd returned registrars will have an IANA id less than this
+   * @param resultSetMaxSize the maximum number of registrar entities to be returned
+   */
+  public static Iterable<Registrar> loadByIanaIdentifierRange(
+      final Long ianaIdentifierStart,
+      final Long ianaIdentifierAfterEnd,
+      final int resultSetMaxSize) {
+    return ofy().doTransactionless(new Work<Iterable<Registrar>>() {
+      @Override
+      public Iterable<Registrar> run() {
+        return ofy().load()
+            .type(Registrar.class)
+            .filter("ianaIdentifier >=", ianaIdentifierStart)
+            .filter("ianaIdentifier <", ianaIdentifierAfterEnd)
+            .limit(resultSetMaxSize);
+      }});
+  }
+
   /** Loads all registrar entities. */
   public static Iterable<Registrar> loadAll() {
     return ofy().load().type(Registrar.class).ancestor(getCrossTldKey());

java/google/registry/rdap/RdapEntityAction.java

@@ -20,6 +20,7 @@ import static google.registry.request.Action.Method.HEAD;
 
 import com.google.common.base.Optional;
 import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.Iterables;
 import com.google.re2j.Pattern;
 import com.googlecode.objectify.Key;
 import google.registry.model.contact.ContactResource;
@@ -34,7 +35,14 @@ import javax.inject.Inject;
 import org.joda.time.DateTime;
 
 /**
- * RDAP (new WHOIS) action for entity (contact and registrar) requests.
+ * RDAP (new WHOIS) action for entity (contact and registrar) requests. the ICANN operational
+ * profile dictates that the "handle" for registrars is to be the IANA registrar ID:
+ *
+ * <p>2.8.3. Registries MUST support lookup for entities with the registrar role within other
+ * objects using the handle (as described in 3.1.5 of RFC7482). The handle of the entity with the
+ * registrar role MUST be equal to IANA Registrar ID. The entity with the registrar role in the RDAP
+ * response MUST contain a publicIDs member to identify the IANA Registrar ID from the IANA’s
+ * Registrar ID registry. The type value of the publicID object MUST be equal to IANA Registrar ID.
  */
 @Action(path = RdapEntityAction.PATH, method = {GET, HEAD}, isPrefix = true)
 public class RdapEntityAction extends RdapActionBase {
@@ -80,17 +88,23 @@ public class RdapEntityAction extends RdapActionBase {
             now);
       }
     }
-    String clientId = pathSearchString.trim();
+    try {
-    if ((clientId.length() >= 3) && (clientId.length() <= 16)) {
+      Long ianaIdentifier = Long.parseLong(pathSearchString);
       wasValidKey = true;
-      Registrar registrar = Registrar.loadByClientId(clientId);
+      Registrar registrar = Iterables.getOnlyElement(
+          Registrar.loadByIanaIdentifierRange(ianaIdentifier, ianaIdentifier + 1, 1), null);
       if ((registrar != null) && registrar.isActiveAndPubliclyVisible()) {
         return RdapJsonFormatter.makeRdapJsonForRegistrar(
             registrar, true, rdapLinkBase, rdapWhoisServer, now);
       }
+    } catch (NumberFormatException e) {
+      // Although the search string was not a valid IANA identifier, it might still have been a
+      // valid ROID.
     }
-    throw !wasValidKey
+    // At this point, we have failed to find either a contact or a registrar.
-        ? new BadRequestException(pathSearchString + " is not a valid entity handle")
+    throw wasValidKey
-        : new NotFoundException(pathSearchString + " not found");
+        ? new NotFoundException(pathSearchString + " not found")
+        : new BadRequestException(pathSearchString + " is not a valid entity handle");
   }
 }
+

java/google/registry/rdap/RdapEntitySearchAction.java

@@ -104,7 +104,7 @@ public class RdapEntitySearchAction extends RdapActionBase {
 
   /**
    * Searches for entities by name, returning a JSON array of entity info maps.
-   * 
+   *
    * <p>As per Gustavo Lozano of ICANN, registrar name search should be by registrar name only, not
    * by registrar contact name:
    *
@@ -112,7 +112,7 @@ public class RdapEntitySearchAction extends RdapActionBase {
    * in the Base Registry Agreement (see 1.6 of Section 4 of the Base Registry Agreement,
    * https://newgtlds.icann.org/sites/default/files/agreements/
    * agreement-approved-09jan14-en.htm).
-   * 
+   *
    * <p>According to RFC 7482 section 6.1, punycode is only used for domain name labels, so we can
    * assume that entity names are regular unicode.
    */
@@ -162,17 +162,18 @@ public class RdapEntitySearchAction extends RdapActionBase {
           .type(ContactResource.class)
           .id(partialStringQuery.getInitialString())
           .now();
-      Registrar registrar = Registrar.loadByClientId(partialStringQuery.getInitialString());
+      ImmutableList<Registrar> registrars = getMatchingRegistrars(partialStringQuery);
       return makeSearchResults(
           ((contactResource == null) || !contactResource.getDeletionTime().isEqual(END_OF_TIME))
               ? ImmutableList.<ContactResource>of() : ImmutableList.of(contactResource),
-          (registrar == null)
+          registrars,
-              ? ImmutableList.<Registrar>of() : ImmutableList.of(registrar),
           now);
     // Handle queries with a wildcard, but no suffix. For contact resources, the deletion time will
     // always be END_OF_TIME for non-deleted records; unlike domain resources, we don't need to
     // worry about deletion times in the future. That allows us to use an equality query for the
-    // deletion time.
+    // deletion time. Because the handle for registrars is the IANA identifier number, don't allow
+    // wildcard searches for registrars, by simply not searching for registrars if a wildcard is
+    // present.
     } else if (partialStringQuery.getSuffix() == null) {
       return makeSearchResults(
           ofy().load()
@@ -183,10 +184,7 @@ public class RdapEntitySearchAction extends RdapActionBase {
                   "<", Key.create(ContactResource.class, partialStringQuery.getNextInitialString()))
               .filter("deletionTime", END_OF_TIME)
               .limit(rdapResultSetMaxSize),
-          Registrar.loadByClientIdRange(
+          ImmutableList.<Registrar>of(),
-              partialStringQuery.getInitialString(),
-              partialStringQuery.getNextInitialString(),
-              rdapResultSetMaxSize),
           now);
     // Don't allow suffixes in entity handle search queries.
     } else {
@@ -194,6 +192,19 @@ public class RdapEntitySearchAction extends RdapActionBase {
     }
   }
 
+  /** Looks up registrars by handle (i.e. IANA identifier). */
+  private ImmutableList<Registrar>
+      getMatchingRegistrars(final RdapSearchPattern partialStringQuery) {
+    Long ianaIdentifier;
+    try {
+      ianaIdentifier = Long.parseLong(partialStringQuery.getInitialString());
+    } catch (NumberFormatException e) {
+      return ImmutableList.of();
+    }
+    return ImmutableList.copyOf(Registrar.loadByIanaIdentifierRange(
+        ianaIdentifier, ianaIdentifier + 1, rdapResultSetMaxSize));
+  }
+
   /** Builds a JSON array of entity info maps based on the specified contacts and registrars. */
   private ImmutableList<ImmutableMap<String, Object>> makeSearchResults(
       Iterable<ContactResource> contactResources, Iterable<Registrar> registrars, DateTime now)

java/google/registry/rdap/RdapJsonFormatter.java

@@ -621,11 +621,11 @@ public class RdapJsonFormatter {
       DateTime now) {
     ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<>();
     builder.put("objectClassName", "entity");
-    builder.put("handle", registrar.getClientIdentifier());
+    builder.put("handle", registrar.getIanaIdentifier().toString());
     builder.put("status", STATUS_LIST_ACTIVE);
     builder.put("roles", ImmutableList.of(RdapEntityRole.REGISTRAR.rfc7483String));
     builder.put("links",
-        ImmutableList.of(makeLink("entity", registrar.getClientIdentifier(), linkBase)));
+        ImmutableList.of(makeLink("entity", registrar.getIanaIdentifier().toString(), linkBase)));
     builder.put("publicIds",
         ImmutableList.of(
             ImmutableMap.of(
@@ -805,7 +805,7 @@ public class RdapJsonFormatter {
     ImmutableList.Builder<Object> eventsBuilder = new ImmutableList.Builder<>();
     eventsBuilder.add(makeEvent(
         RdapEventAction.REGISTRATION,
-        registrar.getClientIdentifier(),
+        registrar.getIanaIdentifier().toString(),
         registrar.getCreationTime()));
     if ((registrar.getLastUpdateTime() != null)
         && registrar.getLastUpdateTime().isAfter(registrar.getCreationTime())) {

javatests/google/registry/model/registrar/RegistrarTest.java

@@ -125,7 +125,7 @@ public class RegistrarTest extends EntityTestCase {
 
   @Test
   public void testIndexing() throws Exception {
-    verifyIndexing(registrar, "registrarName");
+    verifyIndexing(registrar, "registrarName", "ianaIdentifier");
   }
 
   @Test

javatests/google/registry/rdap/RdapEntityActionTest.java

@@ -75,7 +75,7 @@ public class RdapEntityActionTest {
     // lol
     createTld("lol");
     registrarLol = persistResource(makeRegistrar(
-        "evilregistrar", "Yes Virginia <script>", Registrar.State.ACTIVE));
+        "evilregistrar", "Yes Virginia <script>", Registrar.State.ACTIVE, 101L));
     persistSimpleResources(makeRegistrarContacts(registrarLol));
     registrant = makeAndPersistContactResource(
         "8372808-ERL",
@@ -108,8 +108,8 @@ public class RdapEntityActionTest {
         registrarLol));
     // xn--q9jyb4c
     createTld("xn--q9jyb4c");
-    Registrar registrarIdn =
+    Registrar registrarIdn = persistResource(
-        persistResource(makeRegistrar("idnregistrar", "IDN Registrar", Registrar.State.ACTIVE));
+        makeRegistrar("idnregistrar", "IDN Registrar", Registrar.State.ACTIVE, 102L));
     persistSimpleResources(makeRegistrarContacts(registrarIdn));
     persistResource(makeDomainResource("cat.みんな",
         registrant,
@@ -120,7 +120,7 @@ public class RdapEntityActionTest {
         registrarIdn));
     createTld("1.tld");
     Registrar registrar1tld = persistResource(
-        makeRegistrar("1tldregistrar", "Multilevel Registrar", Registrar.State.ACTIVE));
+        makeRegistrar("1tldregistrar", "Multilevel Registrar", Registrar.State.ACTIVE, 103L));
     persistSimpleResources(makeRegistrarContacts(registrar1tld));
     persistResource(makeDomainResource("cat.1.tld",
         registrant,
@@ -238,12 +238,29 @@ public class RdapEntityActionTest {
 
   @Test
   public void testRegistrar_works() throws Exception {
-    assertThat(generateActualJson(registrarLol.getClientIdentifier())).isEqualTo(
+    assertThat(generateActualJson("101")).isEqualTo(
-        generateExpectedJsonWithTopLevelEntries(
+        generateExpectedJsonWithTopLevelEntries("101", "rdap_registrar.json"));
-            registrarLol.getClientIdentifier(), "rdap_registrar.json"));
     assertThat(response.getStatus()).isEqualTo(200);
   }
 
+  @Test
+  public void testRegistrar102_works() throws Exception {
+    generateActualJson("102");
+    assertThat(response.getStatus()).isEqualTo(200);
+  }
+
+  @Test
+  public void testRegistrar103_works() throws Exception {
+    generateActualJson("103");
+    assertThat(response.getStatus()).isEqualTo(200);
+  }
+
+  @Test
+  public void testRegistrar104_doesNotExist() throws Exception {
+    generateActualJson("104");
+    assertThat(response.getStatus()).isEqualTo(404);
+  }
+
   @Test
   public void testDeletedContact_returns404() throws Exception {
     assertThat(generateActualJson(deletedContact.getRepoId())).isEqualTo(

javatests/google/registry/rdap/RdapEntitySearchActionTest.java

@@ -99,12 +99,12 @@ public class RdapEntitySearchActionTest {
 
     registrar =
         persistResource(
-            makeRegistrar("2-Registrar", "Yes Virginia <script>", Registrar.State.ACTIVE));
+            makeRegistrar("2-Registrar", "Yes Virginia <script>", Registrar.State.ACTIVE, 20L));
     persistSimpleResources(makeRegistrarContacts(registrar));
 
     // inactive
     registrarInactive =
-        persistResource(makeRegistrar("2-RegistrarInact", "No Way", Registrar.State.PENDING));
+        persistResource(makeRegistrar("2-RegistrarInact", "No Way", Registrar.State.PENDING, 21L));
     persistSimpleResources(makeRegistrarContacts(registrarInactive));
 
     // test
@@ -270,7 +270,7 @@ public class RdapEntitySearchActionTest {
     assertThat(generateActualJsonWithFullName("Yes Virginia <script>"))
         .isEqualTo(
             generateExpectedJsonForEntity(
-                "2-Registrar", "Yes Virginia <script>", null, null, "rdap_registrar.json"));
+                "20", "Yes Virginia <script>", null, null, "rdap_registrar.json"));
     assertThat(response.getStatus()).isEqualTo(200);
   }
 
@@ -288,11 +288,11 @@ public class RdapEntitySearchActionTest {
   }
 
   @Test
-  public void testHandleMatch_registrar_found() throws Exception {
+  public void testHandleMatch_20_found() throws Exception {
-    assertThat(generateActualJsonWithHandle("2-Registrar"))
+    assertThat(generateActualJsonWithHandle("20"))
         .isEqualTo(
             generateExpectedJsonForEntity(
-                "2-Registrar", "Yes Virginia <script>", null, null, "rdap_registrar.json"));
+                "20", "Yes Virginia <script>", null, null, "rdap_registrar.json"));
     assertThat(response.getStatus()).isEqualTo(200);
   }
 
@@ -314,13 +314,6 @@ public class RdapEntitySearchActionTest {
     assertThat(response.getStatus()).isEqualTo(404);
   }
 
-  @Test
-  public void testHandleMatch_2rstar_found() throws Exception {
-    assertThat(generateActualJsonWithHandle("2-R*"))
-        .isEqualTo(generateExpectedJson("rdap_multiple_contacts.json"));
-    assertThat(response.getStatus()).isEqualTo(200);
-  }
-
   @Test
   public void testHandleMatch_2rstarWithResultSetSize1_foundOne() throws Exception {
     action.rdapResultSetMaxSize = 1;
@@ -349,12 +342,9 @@ public class RdapEntitySearchActionTest {
   }
 
   @Test
-  public void testHandleMatch_2registstar_found() throws Exception {
+  public void testHandleMatch_20star_notFound() throws Exception {
-    assertThat(generateActualJsonWithHandle("2-Regist*"))
+    generateActualJsonWithHandle("20*");
-        .isEqualTo(
+    assertThat(response.getStatus()).isEqualTo(404);
-            generateExpectedJsonForEntity(
-                "2-Registrar", "Yes Virginia <script>", null, null, "rdap_registrar.json"));
-    assertThat(response.getStatus()).isEqualTo(200);
   }
 
   @Test

javatests/google/registry/rdap/testdata/rdap_registrar.json

@@ -16,7 +16,7 @@
   [
     {
       "type" : "IANA Registrar ID",
-      "identifier" : "1"
+      "identifier" : "%NAME%"
     }
   ],
   "events": [

javatests/google/registry/rdap/testdata/rdapjson_registrar.json

@@ -1,21 +1,21 @@
 {
   "objectClassName" : "entity",
-  "handle" : "unicoderegistrar",
+  "handle" : "1",
   "status" : ["active"],
   "roles" : ["registrar"],
   "links" :
   [
     {
-      "value" : "http://myserver.google.com/entity/unicoderegistrar",
+      "value" : "http://myserver.google.com/entity/1",
       "rel" : "self",
-      "href" : "http://myserver.google.com/entity/unicoderegistrar",
+      "href" : "http://myserver.google.com/entity/1",
       "type" : "application/rdap+json"
     }
   ],
   "events": [
     {
       "eventAction": "registration",
-      "eventActor": "unicoderegistrar",
+      "eventActor": "1",
       "eventDate": "1999-01-01T00:00:00.000Z"
     },
     {

javatests/google/registry/testing/FullFieldsTestEntityHelper.java

@@ -51,11 +51,16 @@ public final class FullFieldsTestEntityHelper {
 
   public static Registrar makeRegistrar(
       String clientId, String registrarName, Registrar.State state) {
+    return makeRegistrar(clientId, registrarName, state, 1L);
+  }
+
+  public static Registrar makeRegistrar(
+      String clientId, String registrarName, Registrar.State state, Long ianaIdentifier) {
     Registrar registrar = new Registrar.Builder()
       .setClientIdentifier(clientId)
       .setRegistrarName(registrarName)
       .setType(Registrar.Type.REAL)
-      .setIanaIdentifier(1L)
+      .setIanaIdentifier(ianaIdentifier)
       .setState(state)
       .setInternationalizedAddress(new RegistrarAddress.Builder()
           .setStreet(ImmutableList.of("123 Example Boulevard <script>"))