diff --git a/README.md b/README.md index a912c16..c63614e 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,8 @@ If your current version is not immediately before the latest, you must run the u ### [Initial Operation Guide](docs/iog.md) +### [Namingo EPP Server](docs/epp.md) + ### [FAQ](docs/faq.md) ### [Architecture of Namingo](docs/architecture.md) diff --git a/docs/epp.md b/docs/epp.md new file mode 100644 index 0000000..2cf9a94 --- /dev/null +++ b/docs/epp.md @@ -0,0 +1,1013 @@ +# Namingo Registry EPP Server + +This section includes examples of commonly used EPP commands for domains, hosts, contacts, and session management. Explore key operations like create, update, delete, transfer, and poll, with practical XML samples for each. + +## Commands + +### 1. Session + +#### 1.1. Login Request + +```xml + + + + + username + password + + 1.0 + en + + + urn:ietf:params:xml:ns:domain-1.0 + urn:ietf:params:xml:ns:contact-1.0 + urn:ietf:params:xml:ns:host-1.0 + + urn:ietf:params:xml:ns:secDNS-1.1 + urn:ietf:params:xml:ns:rgp-1.0 + urn:ietf:params:xml:ns:launch-1.0 + urn:ietf:params:xml:ns:idn-1.0 + urn:ietf:params:xml:ns:epp:fee-1.0 + https://namingo.org/epp/funds-1.0 + https://namingo.org/epp/identica-1.0 + + + + namingo-1234567890-abcdef1234 + + +``` + +#### 1.2. Logout Request + +```xml + + + + + namingo-1234567890-abcdef1234 + + +``` + +#### 1.3. Hello Request + +```xml + + + + +``` + +#### 1.4. Poll Request + +```xml + + + + + ABC-12345-XYZ + + +``` + +#### 1.5. Poll Acknowledge + +```xml + + + + + ABC-67890-XYZ + + +``` + +### 2. Contact + +#### 2.1. Contact Check Request + +```xml + + + + + + abc-56789 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 2.2. Contact Create Request + +Standard request: + +```xml + + + + + + abc-56789 + + Ivan Ivanenko + LLC "Prykladna Orhanizatsiya" + + Shevchenka St, 10 + Office 5 + Kyiv + Kyivska oblast + 01001 + UA + + + +380.441234567 + +380.442345678 + example@domain.ua + + D0main$ecret42 + + + + namingo-1234567890-abcdef1234 + + +``` + +Request with Identica extension: + +```xml + + + + + + abc-56789 + + Ivan Ivanenko + LLC "Prykladna Orhanizatsiya" + + Shevchenka St, 10 + Office 5 + Kyiv + Kyivska oblast + 01001 + UA + + + +380.441234567 + +380.442345678 + example@domain.ua + + D0main$ecret42 + + + + + + 1234567890 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 2.3. Contact Info Request + +```xml + + + + + + abc-56789 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 2.4. Contact Update Request + +Standard request: + +```xml + + + + + + abc-12345 + + + Petro Petrenko + LLC "Nova Orhanizatsiya" + + Hrushevskoho St, 15 + Building B + Suite 12 + Odesa + Odeska oblast + 65000 + UA + + + +380.482123456 + +380.482654321 + example@newdomain.ua + + + + namingo-1234567890-abcdef1234 + + +``` + +Request with Identica extension: + +```xml + + + + + + abc-12345 + + + Petro Petrenko + LLC "Nova Orhanizatsiya" + + Hrushevskoho St, 15 + Building B + Suite 12 + Odesa + Odeska oblast + 65000 + UA + + + +380.482123456 + +380.482654321 + example@newdomain.ua + + + + + + 1234567890 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 2.5. Contact Delete Request + +```xml + + + + + + abc-12398 + + + namingo-1234567890-abcdef1234 + + +``` + +### 3. Host + +#### 3.1. Host Check Request + +```xml + + + + + + ns1.example.test + + + namingo-1234567890-abcdef1234 + + +``` + +#### 3.2. Host Create Request + +```xml + + + + + + ns1.example.test + 192.0.2.1 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 3.3. Host Info Request + +```xml + + + + + + ns1.example.test + + + namingo-1234567890-abcdef1234 + + +``` + +#### 3.4. Host Update Request + +```xml + + + + + + ns1.example.test + + 198.51.100.2 + + + 192.0.2.1 + + + + namingo-1234567890-abcdef1234 + + +``` + +#### 3.5. Host Delete Request + +```xml + + + + + + ns2.example.test + + + namingo-1234567890-abcdef1234 + + +``` + +### 4. Domain + +#### 4.1. Domain Check Request + +Standard request: + +```xml + + + + + + example.test + example.example + + + namingo-1234567890-abcdef1234 + + +``` + +Check for claims: + +```xml + + + + + + example.test + example.example + + + + + claims + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.2. Domain Create Request + +Standard request: + +```xml + + + + + + myexample.test + 1 + + ns1.example.example + ns2.example.example + + abc-56789 + abc-12345 + abc-12345 + abc-12345 + + D0main$ecret42 + + + + namingo-1234567890-abcdef1234 + + +``` + +Request with DNSSEC: + +```xml + + + + + + myexample.test + 1 + + ns1.example.example + ns2.example.example + + abc-56789 + abc-12345 + abc-12345 + abc-12345 + + D0main$ecret42 + + + + + + + + 12345 + 8 + 2 + 49FD46E6C4B45C55D4AC93CE4721E8C6DB6FAB1D + + + 67890 + 13 + 2 + 3A5B4C2D75E3F58B907BD2318D3470FBC9038D40 + + + + + namingo-1234567890-abcdef1234 + + +``` + +Request with claims: + +```xml + + + + + + myexample.test + 1 + + ns1.example.example + ns2.example.example + + abc-56789 + abc-12345 + abc-12345 + abc-12345 + + D0main$ecret42 + + + + + + claims + + ABC-12345678-XYZ + 2024-12-31T23:59:59Z + 2024-11-28T14:30:00Z + + + + namingo-1234567890-abcdef1234 + + +``` + +Request for sunrise: + +```xml + + + + + + myexample.test + 1 + + ns1.example.example + ns2.example.example + + abc-56789 + abc-12345 + abc-12345 + abc-12345 + + D0main$ecret42 + + + + + + sunrise + + PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHNnbTpzaWduZWRNYXJrIHhtbG5zOnNnbT0idXJuOmlldGY6cGFyYW1zOnhtbDpuczpzaWduZWRNYXJrLTEuMCI+CiAgPHNnbTp0bWNoSWRlbnRpdHk+RG9tYWluTmFtZS5jb208L3NnbTp0bWNoSWRlbnRpdHk+CiAgPHNnbTp0bWNoRGV0YWlscz4KICAgIDxzZ206dG1jaFN0YXR1cz5WYWxpZDwvc2dtOnRtY2hTdGF0dXM+CiAgPC9zZ206dG1jaERldGFpbHM+CiAgPHNnbTpzaWduYXR1cmU+CiAgICA8c2dtOnNpZ25hdHVyZU1ldGhvZD5yc2Etc2hhMjU2PC9zZ206c2lnbmF0dXJlTWV0aG9kPgogICAgPHNnbTpkaWdlc3Q+...base64encodeddata... + + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.3. Domain Info Request + +Standard request: + +```xml + + + + + + myexample.test + + authInfoPw + + + + namingo-1234567890-abcdef1234 + + +``` + +Response with Identica in database: + +```xml +... + + + 1234567890 + + +... +``` + +#### 4.4. Domain Update Request + +```xml + + + + + + myexample.test + + + ns1.example.example + + bcd-92345 + + + + + ns3.example.example + + bcd-92345 + + + + bcd-92345 + + D0main$ecret42 + + + + + + + + 12345 + 8 + 2 + 49FD46E6C4B45C55D4AC + + + + + 67890 + 8 + 2 + 23AB56C7D8EF9AB34A12 + + + + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.5. Domain Renew Request + +```xml + + + + + + myexample.test + 2024-10-01 + 1 + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.6. Domain Transfer Request + +Request: + +```xml + + + + + + myexample.test + 1 + + D0main$ecret42 + + + + namingo-1234567890-abcdef1234 + + +``` + +Query: + +```xml + + + + + + myexample.test + + + namingo-1234567890-abcdef1234 + + +``` + +Approve: + +```xml + + + + + + myexample.test + + + namingo-1234567890-abcdef1234 + + +``` + +Cancel: + +```xml + + + + + + myexample.test + + + namingo-1234567890-abcdef1234 + + +``` + +Reject: + +```xml + + + + + + myexample.test + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.7. Domain Delete Request + +```xml + + + + + + myexample.test + + + namingo-1234567890-abcdef1234 + + +``` + +#### 4.8. Domain Restore Request + +Request: + +```xml + + + + + + example.test + + + + + + + + namingo-1234567890-abcdef1234 + + +``` + +Report: + +```xml + + + + + + example.test + + + + + + + Pre-delete registration data goes here. + Both XML and free text are allowed. + Post-restore registration data goes here. + Both XML and free text are allowed. + 2019-10-10T22:00:00.0Z + 2019-10-20T22:00:00.0Z + Registrant error. + This registrar has not restored the + Registered Name in order to assume the rights to use + or sell the Registered Name for itself or for any + third party. + The information in this report is + true to best of this registrars knowledge, and this + registrar acknowledges that intentionally supplying + false information in this report shall constitute an + incurable material breach of the + Registry-Registrar Agreement. + Supporting information goes + here. + + + + + namingo-1234567890-abcdef1234 + + +``` + +### 5. Extensions + +#### 5.1. Funds Info Request + +Request: + +```xml + + + + + + + + namingo-1234567890-abcdef1234 + + +``` + +Response: + +```xml + + + + + Command completed successfully + + + + 100000.00 + USD + 100000.00 + 100000.00 + + 500.00 + + + + + client-20241128-12345 + namingo-1234567890-abcdef1234 + + + +``` \ No newline at end of file diff --git a/epp/src/helpers.php b/epp/src/helpers.php index 13d3955..587d938 100644 --- a/epp/src/helpers.php +++ b/epp/src/helpers.php @@ -78,8 +78,7 @@ function sendGreeting($conn) { 'urn:ietf:params:xml:ns:rgp-1.0', 'urn:ietf:params:xml:ns:launch-1.0', 'urn:ietf:params:xml:ns:idn-1.0', - 'urn:ietf:params:xml:ns:epp:fee-1.0', - 'urn:ar:params:xml:ns:price-1.1' + 'urn:ietf:params:xml:ns:epp:fee-1.0' ], 'dcp' => [ // Data Collection Policy (optional) 'access' => ['all'],