kylefang/stacks-puppet-node
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-04-21 18:32:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

rounding out the subdomain doc

Browse Source
This commit is contained in:
Aaron Blankstein
2017-08-03 10:40:19 -04:00
parent 0574401cd0
commit 0d8a04ad80
1 changed files with 45 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/subdomains.md
View File

@@ -180,6 +180,48 @@ When a lookup like `foo.bar.id` hits the resolver, the resolver will need to:
5. Do a profile lookup for `foo.bar.id` by fetching the URLs in the entry.
*Note*, this spec does not define a priority order for fetching those URLs.
#### Supported Core / Resolver Endpoints
Generally, domain endpoints are not aware of subdomains (only endpoint
aware of subdomains is `/v1/users/<foo.bar.tld>`)
This means that search, login, and 'names owned by address X' queries
are *not* yet supported. Support for these requires varying levels of
engineering, with login and zonefile lookups being the easiest to
support, while names owned by address X lookups will require that the
resolver subdomain cache be greedily populated rather than lazily.
The lookup works just like a normal lookup -- it returns the user's
profile object:
```
$ curl -H "Authorization: bearer blockstack_integration_test_api_password" -H "Origin: http://localhost:3000" http://localhost:16268/v1/users/bar.foo.id -v -s | python -m json.tool
* Trying 127.0.0.1...
* Connected to localhost (127.0.0.1) port 16268 (#0)
> GET /v1/users/bar.foo.id HTTP/1.1
> Host: localhost:16268
> User-Agent: curl/7.50.1
> Accept: */*
> Authorization: bearer blockstack_integration_test_api_password
> Origin: http://localhost:3000
>
* HTTP 1.0, assume close after body
< HTTP/1.0 200 OK
< Server: SimpleHTTP/0.6 Python/2.7.12+
< Date: Thu, 03 Aug 2017 14:39:16 GMT
< content-type: application/json
< Access-Control-Allow-Origin: *
<
{ [66 bytes data]
* Closing connection 0
{
"bar": {
"@type": "Person",
"description": "Lorem Ipsum Bazorem"
}
}
```
#### Subdomain Caching
A resolver *caches* a subdomain's state by keeping a database of all
@@ -187,7 +229,6 @@ the current subdomain records. This database is automatically updated
when a new zonefile for a particularly domain is seen by the resolver
(this is performed lazily).
#### Todos
1. Testing bad zonefile transitions / updates.
@@ -197,4 +238,6 @@ when a new zonefile for a particularly domain is seen by the resolver
3. Batching updates [x]
4. Web API [x]
5. Resolver database cache for holding *multiple* domains, instead of just one [x]
6. Endpoint support for changing zonefiles/rotating keys [o]
6. Resolver should be able to authenticate an owned subdomain [o]
7. Resolver should be able to respond to *names_owned_by_address* queries [o]
8. Endpoint support for changing zonefiles/rotating keys [o]