use IPv4 for now

.env.dev

@@ -1,5 +1,5 @@
 export DOMIPLY_HTTP_DOMAIN=localhost
 export DOMIPLY_PASSPHRASE=foobar
 export DOMIPLY_ORIGIN_STORE_GIT_DIR_PATH=/tmp/domiply_dev_env/origin/git
-export DOMIPLY_DOMAIN_CHECKER_TARGET_AAAA=::1
+export DOMIPLY_DOMAIN_CHECKER_TARGET_A=127.0.0.1
 export DOMIPLY_DOMAIN_CONFIG_STORE_DIR_PATH=/tmp/domiply_dev_env/domain/config

README.md

@@ -0,0 +1,30 @@
+# Domiply
+
+Domiply is a self-hosted rust service which connects a DNS hostname to a data
+backend (e.g. a git repository), all with no account needed. The user only
+inputs their domain name, their desired backend, and then adds two entries to
+their DNS server.
+
+[Demo which may or may not be live](https://domiply.mediocregopher.com)
+
+## Development
+
+Domiply uses nix flakes for building and setting up the development environment.
+In order to open a shell with all necessary tooling (expected rust toolchain
+versions, etc...) simply do:
+
+```
+nix develop
+```
+
+Within the shell which opens you can do `cargo run` to start a local instance.
+
+In order to create a release binary:
+
+```
+nix build
+```
+
+## Roadmap
+
+Check out the `src/service/http_tpl/index.html` file for the current roadmap.

src/domain/checker.rs

@@ -20,8 +20,8 @@ pub enum NewDNSCheckerError {
 
 #[derive(thiserror::Error, Debug)]
 pub enum CheckDomainError {
-    #[error("target AAAA not set")]
-    TargetAAAANotSet,
+    #[error("target A not set")]
+    TargetANotSet,
 
     #[error("challenge token not set")]
     ChallengeTokenNotSet,
@@ -31,7 +31,7 @@ pub enum CheckDomainError {
 }
 
 pub struct DNSChecker {
-    target_aaaa: net::Ipv6Addr,
+    target_a: net::Ipv4Addr,
 
     // TODO we should use some kind of connection pool here, I suppose
     client: tokio::sync::Mutex<AsyncClient>,
@@ -39,7 +39,7 @@ pub struct DNSChecker {
 
 pub fn new(
     tokio_runtime: sync::Arc<tokio::runtime::Runtime>,
-    target_aaaa: net::Ipv6Addr,
+    target_a: net::Ipv4Addr,
     resolver_addr: &str,
 ) -> Result<DNSChecker, NewDNSCheckerError> {
     let resolver_addr = resolver_addr
@@ -55,7 +55,7 @@ pub fn new(
     tokio_runtime.spawn(bg);
 
     Ok(DNSChecker {
-        target_aaaa,
+        target_a,
         client: tokio::sync::Mutex::new(client),
     })
 }
@@ -84,14 +84,14 @@ impl DNSChecker {
             let records = response.answers();
 
             if records.len() != 1 {
-                return Err(CheckDomainError::TargetAAAANotSet);
+                return Err(CheckDomainError::TargetANotSet);
             }
 
-            // if the single record isn't a AAAA, or it's not the target AAAA, then return
-            // TargetAAAANAMENotSet
+            // if the single record isn't a A, or it's not the target A, then return
+            // TargetANAMENotSet
             match records[0].data() {
-                Some(RData::AAAA(remote_aaaa)) if remote_aaaa == &self.target_aaaa => (),
-                _ => return Err(CheckDomainError::TargetAAAANotSet),
+                Some(RData::A(remote_a)) if remote_a == &self.target_a => (),
+                _ => return Err(CheckDomainError::TargetANotSet),
             }
         }
 

src/domain/manager.rs

@@ -72,8 +72,8 @@ pub enum SyncWithConfigError {
     #[error("already in progress")]
     AlreadyInProgress,
 
-    #[error("target AAAA not set")]
-    TargetAAAANotSet,
+    #[error("target A/AAAA not set")]
+    TargetANotSet,
 
     #[error("challenge token not set")]
     ChallengeTokenNotSet,
@@ -96,7 +96,7 @@ impl From<origin::store::SyncError> for SyncWithConfigError {
 impl From<checker::CheckDomainError> for SyncWithConfigError {
     fn from(e: checker::CheckDomainError) -> SyncWithConfigError {
         match e {
-            checker::CheckDomainError::TargetAAAANotSet => SyncWithConfigError::TargetAAAANotSet,
+            checker::CheckDomainError::TargetANotSet => SyncWithConfigError::TargetANotSet,
             checker::CheckDomainError::ChallengeTokenNotSet => {
                 SyncWithConfigError::ChallengeTokenNotSet
             }

src/main.rs

@@ -29,8 +29,8 @@ struct Cli {
     #[arg(long, required = true, env = "DOMIPLY_ORIGIN_STORE_GIT_DIR_PATH")]
     origin_store_git_dir_path: path::PathBuf,
 
-    #[arg(long, required = true, env = "DOMIPLY_DOMAIN_CHECKER_TARGET_AAAA")]
-    domain_checker_target_aaaa: std::net::Ipv6Addr,
+    #[arg(long, required = true, env = "DOMIPLY_DOMAIN_CHECKER_TARGET_A")]
+    domain_checker_target_a: std::net::Ipv4Addr,
 
     #[arg(long, default_value_t = String::from("1.1.1.1:53"), env = "DOMIPLY_DOMAIN_CHECKER_RESOLVER_ADDR")]
     domain_checker_resolver_addr: String,
@@ -115,7 +115,7 @@ fn main() {
 
     let domain_checker = domiply::domain::checker::new(
         tokio_runtime.clone(),
-        config.domain_checker_target_aaaa,
+        config.domain_checker_target_a,
         &config.domain_checker_resolver_addr,
     )
     .expect("domain checker initialized");
@@ -128,9 +128,9 @@ fn main() {
 
     let service = domiply::service::new(
         manager,
-        config.domain_checker_target_aaaa,
+        config.domain_checker_target_a,
         config.passphrase,
-        config.http_domain,
+        config.http_domain.clone(),
     );
 
     let service = sync::Arc::new(service);
@@ -153,7 +153,7 @@ fn main() {
         tokio_runtime.spawn(async move {
             let addr = config.http_listen_addr;
 
-            println!("Listening on {addr}");
+            println!("Listening on http://{}:{}", config.http_domain, addr.port());
             let server = hyper::Server::bind(&addr).serve(make_service);
 
             let graceful = server.with_graceful_shutdown(async {

src/service.rs

@@ -17,7 +17,7 @@ type SvcResponse = Result<Response<hyper::body::Body>, String>;
 #[derive(Clone)]
 pub struct Service<'svc> {
     domain_manager: sync::Arc<dyn domain::manager::Manager>,
-    target_aaaa: net::Ipv6Addr,
+    target_a: net::Ipv4Addr,
     passphrase: String,
     http_domain: String,
     handlebars: handlebars::Handlebars<'svc>,
@@ -25,13 +25,13 @@ pub struct Service<'svc> {
 
 pub fn new<'svc, 'mgr>(
     domain_manager: sync::Arc<dyn domain::manager::Manager>,
-    target_aaaa: net::Ipv6Addr,
+    target_a: net::Ipv4Addr,
     passphrase: String,
     http_domain: String,
 ) -> Service<'svc> {
     Service {
         domain_manager,
-        target_aaaa,
+        target_a,
         passphrase,
         http_domain,
         handlebars: self::http_tpl::get().expect("Retrieved Handlebars templates"),
@@ -52,12 +52,12 @@ struct DomainGetArgs {
 #[derive(Deserialize)]
 struct DomainInitArgs {
     domain: domain::Name,
-    passphrase: String,
 }
 
 #[derive(Deserialize)]
 struct DomainSyncArgs {
     domain: domain::Name,
+    passphrase: String,
 }
 
 impl<'svc> Service<'svc> {
@@ -179,31 +179,30 @@ impl<'svc> Service<'svc> {
             config: Option<domain::config::Config>,
         }
 
-        match self.domain_manager.get_config(&args.domain) {
-            Ok(_config) => self.render_error_page(500, "TODO not yet implemented"),
-            Err(domain::manager::GetConfigError::NotFound) => self.render_page(
-                "/domain.html",
-                &Response {
-                    domain: args.domain,
-                    config: None,
-                },
-            ),
+        let config = match self.domain_manager.get_config(&args.domain) {
+            Ok(config) => Some(config),
+            Err(domain::manager::GetConfigError::NotFound) => None,
             Err(domain::manager::GetConfigError::Unexpected(e)) => {
-                self.render_error_page(500, format!("retrieving configuration: {}", e).as_str())
+                return self
+                    .render_error_page(500, format!("retrieving configuration: {}", e).as_str());
             }
-        }
+        };
+
+        self.render_page(
+            "/domain.html",
+            &Response {
+                domain: args.domain,
+                config: config,
+            },
+        )
     }
 
     fn domain_init(&self, args: DomainInitArgs, domain_config: util::FlatConfig) -> SvcResponse {
-        if args.passphrase != self.passphrase.as_str() {
-            return self.render_error_page(401, "Incorrect passphrase");
-        }
-
         #[derive(Serialize)]
         struct Response {
             domain: domain::Name,
             flat_config: util::FlatConfig,
-            target_aaaa: net::Ipv6Addr,
+            target_a: net::Ipv4Addr,
             challenge_token: String,
         }
 
@@ -228,7 +227,7 @@ impl<'svc> Service<'svc> {
             &Response {
                 domain: args.domain,
                 flat_config: config.into(),
-                target_aaaa: self.target_aaaa,
+                target_a: self.target_a,
                 challenge_token: config_hash,
             },
         );
@@ -239,6 +238,10 @@ impl<'svc> Service<'svc> {
         args: DomainSyncArgs,
         domain_config: util::FlatConfig,
     ) -> SvcResponse {
+        if args.passphrase != self.passphrase.as_str() {
+            return self.render_error_page(401, "Incorrect passphrase");
+        }
+
         let config: domain::config::Config = match domain_config.try_into() {
             Ok(Some(config)) => config,
             Ok(None) => return self.render_error_page(400, "domain config is required"),
@@ -263,7 +266,7 @@ impl<'svc> Service<'svc> {
         Err(domain::manager::SyncWithConfigError::InvalidURL) => Some("Fetching the git repository failed, please double check that you input the correct URL.".to_string()),
         Err(domain::manager::SyncWithConfigError::InvalidBranchName) => Some("The git repository does not have a branch of the given name, please double check that you input the correct name.".to_string()),
         Err(domain::manager::SyncWithConfigError::AlreadyInProgress) => Some("The configuration of your domain is still in progress, please refresh in a few minutes.".to_string()),
-        Err(domain::manager::SyncWithConfigError::TargetAAAANotSet) => Some("The AAAA record is not set correctly on the domain. Please double check that you put the correct value on the record. If the value is correct, then most likely the updated records have not yet propagated. In this case you can refresh in a few minutes to try again.".to_string()),
+        Err(domain::manager::SyncWithConfigError::TargetANotSet) => Some("The A record is not set correctly on the domain. Please double check that you put the correct value on the record. If the value is correct, then most likely the updated records have not yet propagated. In this case you can refresh in a few minutes to try again.".to_string()),
         Err(domain::manager::SyncWithConfigError::ChallengeTokenNotSet) => Some("The TXT record is not set correctly on the domain. Please double check that you put the correct value on the record. If the value is correct, then most likely the updated records have not yet propagated. In this case you can refresh in a few minutes to try again.".to_string()),
         Err(domain::manager::SyncWithConfigError::Unexpected(e)) => Some(format!("An unexpected error occurred: {e}")),
         };

src/service/http_tpl/base.html

@@ -17,6 +17,12 @@
 
   <link rel="stylesheet" type="text/css" href="/static/bamboo.css" />
 
+  <style>
+    form {
+      margin-bottom: 2rem;
+    }
+  </style>
+
 </head>
 
 <body>

src/service/http_tpl/domain.html

@@ -2,11 +2,21 @@
   Configure New Domain
 </h2>
 
+{{# if data.config }}
+
+<p>Your domain <code>{{ data.domain }}</code> is already configured with
+Domiply. You can see the existing configuration below. If you modify any values
+you will need to hit the "Next" button to complete the update.</p>
+
+{{ else }}
+
 <p>Your domain <code>{{ data.domain }}</code> is not yet configured with Domiply.
 To get started, please input the details of a public git repo which will be used
 to serve your domain. When you update the given branch, your domain will be
 automatically updated too!</p>
 
+{{/if}}
+
 <p><em>In the future Domiply will support more backends than just git
   repos.</em></p>
 
@@ -14,11 +24,6 @@ automatically updated too!</p>
   <input name="domain" type="hidden" value="{{ data.domain }}" />
   <input name="config_origin_descr_kind" type="hidden" value="git" />
 
-  <label>
-    Passphrase (required during closed-beta):
-    <input name="passphrase" placeholder="shhhh" required />
-  </label>
-
   <fieldset>
     <legend>Git Repository</legend>
     <p>

src/service/http_tpl/domain_init.html

@@ -5,8 +5,8 @@ are two entries you will need to add:</p>
 
 <ul>
   <li>
-    A <code>AAAA {{ data.domain }}</code> entry with the value
-    <code>{{ data.target_aaaa }}</code>
+    A <code>A {{ data.domain }}</code> entry with the value
+    <code>{{ data.target_a }}</code>
   </li>
   <li>
     A <code>TXT _domiply_challenge.{{ data.domain }}</code> entry with the value
@@ -22,5 +22,13 @@ and set up your domain.</p>
   {{ #each data.flat_config }}
   <input name="{{ @key }}" type="hidden" value="{{ this }}" />
   {{ /each }}
+
+  <fieldset>
+    <label>
+      Passphrase (required during closed-beta):
+      <input name="passphrase" placeholder="shhhh" required />
+    </label>
+  </fieldset>
+
   <input type="submit" value="Next" />
 </form>

src/service/http_tpl/index.html

@@ -2,30 +2,26 @@
 account needed. Just input your desired backend, add two entries to your DNS
 server, and you're done!</p>
 
-<p><strong>Domiply is currently only a proof-of-concept with limited features,
-  but will continue to be expanded as development time permits</strong></p>
+<p><strong>YOU SHOULD NOT USE THIS FOR ANYTHING YOU CARE ABOUT AT THIS
+  TIME.</strong></p>
 
-<p>The following backends are supported for serving a domain:</p>
-
-<ul>
-  <li><strong>Git repository</strong>: Your domain will be served out of a
-    branch of a public git repository, a la Github Pages.</li>
-  <li><strong>IPFS/IPNS Hash</strong>: TODO</li>
-  <li><strong>Alternative URL (reverse proxy)</strong>: TODO</li>
-  <li><strong>Google Drive</strong>: TODO (maybe)</li>
-  <li><strong>Dropbox</strong>: TODO (maybe)</li>
-</ul>
+<p>Domiply is currently only a proof-of-concept with limited features,
+  but will continue to be expanded as development time permits.</p>
 
 <h2>Get Started</h2>
 
-<p>Input your domain name below to set it up, or reconfigure it if you have used
-it before:</p>
+<p>Input your domain name below to set it up, or to reconfigure it has already
+been set up.</p>
 
 <form method="get" action="/domain.html">
-  <label>
-    Domain name:
-    <input type="text" name="domain" placeholder="example.org" required />
-  </label>
+
+  <fieldset>
+    <label>
+      Domain name:
+      <input type="text" name="domain" placeholder="example.org" required />
+    </label>
+
+  </fieldset>
 
   <input type="submit" value="Go!" />
 </form>
@@ -33,10 +29,9 @@ it before:</p>
 <p>Alternatively you can do any of the following alternative actions:</p>
 
 <ul>
-  <li>List all existing domains</li>
+  <li>List all existing domains (TODO)</li>
   <li>View the Source Code (TODO)</li>
-  <li>View the Project Roadmap (TODO)</li>
-  <li>Report a Bug (TODO)</li>
+  <li><a href="mailto:me@mediocregopher.com">Report a Bug</a></li>
 </ul>
 
 <h2>About</h2>
@@ -45,3 +40,22 @@ it before:</p>
 individuals for their community of friends and family. By making it super easy
 to set up a domain we can help our non-technical folk own their own slice of
 the internet, the way it was always intended.</p>
+
+<h2>Roadmap</h2>
+
+<p>Domiply is very much a work in progress. The following functionality is
+planned but not yet implemented:</p>
+
+<ul>
+  <li>Support for AAAA and CNAME records</li>
+  <li>HTTPS support, with automatic certificate syncing via Let's Encrypt.</li>
+  <li>
+    Support for more backends than just git repositories, including:
+    <ul>
+      <li>IPFS/IPNS Hash</li>
+      <li>Alternative URL (reverse proxy)</li>
+      <li>Google Drive / Dropbox</li>
+    </ul>
+  </li>
+  <li>Scalable backend which requires only an S3 compatible database</li>
+</ul>