doc/api/storage.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 title: Storage in Keep
   5 ...
   6
   7 Keep clients are applications such as @arv-get@, @arv-put@ and @arv-mount@ which store and retrieve data from Keep.  In doing so, these programs interact with both the API server (which stores file metadata in form of Collection objects) and individual Keep servers (which store the actual data blocks).
   8
   9 !{{site.baseurl}}/images/Keep_reading_writing_block.svg!
  10
  11 h2. Storing a file
  12
  13 # The client discovers keep servers (or proxies) using the @accessible@ method on "keep_services":{{site.baseurl}}/api/methods/keep_services.html
  14 # Data is split into 64 MiB blocks and the MD5 hash is computed for each block.
  15 # The client uploads each block to one or more Keep servers, based on the number of desired replicas.  The priority order is determined using rendezvous hashing, described below.
  16 # The Keep server returns a block locator (the MD5 sum of the block) and a "signed token" which the client can use as proof of knowledge for the block.
  17 # The client constructs a @manifest@ which lists the blocks by MD5 hash and how to reassemble them into the original files.
  18 # The client creates a "collection":{{site.baseurl}}/api/methods/collections.html and provides the @manifest_text@
  19 # The API server accepts the collection after validating the signed tokens (proof of knowledge) for each block.
  20
  21 !{{site.baseurl}}/images/Keep_manifests.svg!
  22
  23 h2. Fetching a file
  24
  25 # The client requests a @collection@ object including @manifest_text@ from the APIs server
  26 # The server adds "token signatures" to the @manifest_text@ and returns it to the client.
  27 # The client discovers keep servers (or proxies) using the @accessible@ method on "keep_services":{{site.baseurl}}/api/methods/keep_services.html
  28 # For each data block, the client chooses the highest priority server using rendezvous hashing, described below.
  29 # The client sends the data block request to the keep server, along with the token signature from the API which proves to Keep servers that the client is permitted to read a given block.
  30 # The server provides the block data after validating the token signature for the block (if the server does not have the block, it returns a 404 and the client tries the next highest priority server)
  31
  32 !{{site.baseurl}}/images/Keep_rendezvous_hashing.svg!
  33
  34 Each @keep_service@ resource has an assigned uuid.  To determine priority assignments of blocks to servers, for each keep service compute the MD5 sum of the string concatenation of the block locator (hex-coded hash part only) and service uuid, then sort this list in descending order.  Blocks are preferentially placed on servers with the highest weight.
  35
  36 h2. Keep server API
  37
  38 The Keep server is accessed via a simple HTTP REST API.
  39
  40 *GET /blocklocator+size+A@token*
  41
  42 Fetch the data block.  Response returns block contents.  If permission checking is enabled, requires a valid token hint.
  43
  44 *PUT /blocklocator*
  45
  46 Body: the block contents.  Responds the block locator consisting of MD5 sum of the data, block size, and signed token hint.
  47
  48 *POST /*
  49
  50 Body: the block contents.  Responds the block locator consisting of MD5 sum of the data, block size, and signed token hint.
  51
  52 h2(#locator). Keep locator format
  53
  54 BNF notation for a valid Keep locator string (with hints).  For example @d41d8cd98f00b204e9800998ecf8427e+0+Z+Ada39a3ee5e6b4b0d3255bfef95601890afd80709@53bed294@
  55
  56 <pre>
  57 locator        ::= sized-digest hint*
  58 sized-digest   ::= digest size-hint
  59 digest         ::= <32 lowercase hexadecimal digits>
  60 size-hint      ::= "+" [0-9]+
  61 hint           ::= "+" hint-type hint-content
  62 hint-type      ::= [A-Z]+
  63 hint-content   ::= [A-Za-z0-9@_-]*
  64 sign-hint      ::= "+A" <40 lowercase hexadecimal digits> "@" sign-timestamp
  65 sign-timestamp ::= <8 lowercase hexadecimal digits>
  66 </pre>
  67
  68 h3. Token signatures
  69
  70 A token signature (sign-hint) provides proof-of-access for a data block.  It is computed by taking a SHA1 HMAC of the blob signing token (a shared secret between the API server and keep servers), block digest, current API token, expiration timestamp, and blob signature TTL.
  71
  72 When communicating with the Keep store to fetch a block, or the API server to create or update a collection, the service computes the expected token signature for each block and compares it to the token signature that was presented by the client.  Keep clients receive valid block signatures when uploading a block to a keep store (getting back a signed token as proof of knowledge) or, from the API server, getting the manifest text of a collection on which the user has read permission.
  73
  74 Security of a token signature is derived from the following characteristics:
  75
  76 # Valid signatures can only be generated by entities that know the shared secret (the "blob signing token")
  77 # A signature can only be used by an entity that also know the API token that was used to generate it.
  78 # It expires after a set date (the expiration time, based on the "blob signature time-to-live (TTL)")
  79
  80 h3. Regular expression to validate locator
  81
  82 <pre>
  83 /^([0-9a-f]{32})\+([0-9]+)(\+[A-Z][-A-Za-z0-9@_]*)*$/
  84 </pre>
  85
  86 h3. Valid locators
  87
  88 table(table table-bordered table-condensed).
  89 |@d41d8cd98f00b204e9800998ecf8427e+0@|
  90 |@d41d8cd98f00b204e9800998ecf8427e+0+Z@|
  91 |<code>d41d8cd98f00b204e9800998ecf8427e+0+Z+Ada39a3ee5e6b4b0d3255bfef95601890afd80709@53bed294</code>|
  92
  93 h3. Invalid locators
  94
  95 table(table table-bordered table-condensed).
  96 ||Why|
  97 |@d41d8cd98f00b204e9800998ecf8427e@|No size hint|
  98 |@d41d8cd98f00b204e9800998ecf8427e+Z+0@|Other hint before size hint|
  99 |@d41d8cd98f00b204e9800998ecf8427e+0+0@|Multiple size hints|
 100 |@d41d8cd98f00b204e9800998ecf8427e+0+z@|Hint does not start with uppercase letter|
 101 |@d41d8cd98f00b204e9800998ecf8427e+0+Zfoo*bar@|Hint contains invalid character @*@|
 102
 103 h2. Manifest v1
 104
 105 A manifest is utf-8 encoded text, consisting of zero or more newline-terminated streams.
 106
 107 <pre>
 108 manifest       ::= stream*
 109 stream         ::= stream-name (" " locator)+ (" " file-segment)+ "\n"
 110 stream-name    ::= "." ("/" path-component)*
 111 path-component ::= <printable ASCII - (whitespace, "/")>+
 112 file-segment   ::= position ":" size ":" filename
 113 position       ::= [0-9]+
 114 size           ::= [0-9]+
 115 filename       ::= path-component ("/" path-component)*
 116 </pre>
 117
 118 Notes:
 119
 120 * The first token is the stream name, consisting of one or more path components, delimited by @"/"@.
 121 ** The first path component is always @"."@.
 122 ** No path component is empty.
 123 ** No path component following the first one can be "." or "..".
 124 ** The stream name never begins or ends with @"/"@.
 125 * The next N tokens are "keep locators":#locator
 126 ** These describe the "data stream".  By logically concatenating the blocks in the order that they appear, we can refer to "positions" in the data stream.
 127 * File tokens come after the sequence of keep locators.
 128 ** A file token has three parts, delimited by @":"@: position, size, filename.
 129 ** Position and size are given in decimal
 130 ** The position is the position in the data stream
 131 ** The size is the count of bytes following the position in the data stream.  A file size may cross multiple blocks in the data stream.
 132 ** Filename may contain @"/"@ characters, but must not start or end with @"/"@, and must not contain @"//"@.
 133 ** Filename components (delimited by @"/"@) must not be @"."@ or @".."@.
 134 ** There may be multiple file tokens.
 135
 136 It is legal to have multiple file tokens in the manifest (possible across different streams) with the same combined path name @stream name + "/" + filename@.  This must be interpreted as a concatenation of file content, in the order that the file tokens appear in the manifest.
 137
 138 Spaces are represented by the escape sequence @\040@.  Spaces in stream names and filenames must be translated when reading and writing manifests.  A manifest may not contain TAB characters, nor other ASCII whitespace characters or control codes other than the spaces or newlines used as delimiters specified above.  A manifest always ends with a newline -- except the empty (zero-length) string, which is a valid manifest.
 139
 140 h3. Normalized manifest v1
 141
 142 A normalized manifest is a manifest that meets the following additional restrictions:
 143
 144 * Streams are in alphanumeric order.
 145 * Each stream name is unique within the manifest.
 146 * Files within a stream are listed in alphanumeric order.
 147 * Blocks within a stream are ordered based on order of file tokens of the stream.  A given block is listed at most once in a stream.
 148 * Filename must not contain @"/"@ (the stream name represents the path prefix)
 149
 150 h3. Example manifests
 151
 152 A manifest with four files in two directories:
 153
 154 <pre>
 155 . 930625b054ce894ac40596c3f5a0d947+33 0:0:a 0:0:b 0:33:output.txt
 156 ./c d41d8cd98f00b204e9800998ecf8427e+0 0:0:d
 157 </pre>
 158
 159 The same manifest with permission signatures on each block:
 160
 161 <pre>
 162 . 930625b054ce894ac40596c3f5a0d947+33+A1f27a35dd9af37191d63ad8eb8985624451e7b79@5835c8bc 0:0:a 0:0:b 0:33:output.txt
 163 ./c d41d8cd98f00b204e9800998ecf8427e+0+A27117dcd30c013a6e85d6d74c9a50179a1446efa@5835c8bc 0:0:d
 164 </pre>
 165
 166 A manifest containing a file consisting of multiple blocks and a space in the file name:
 167
 168 <pre>
 169 . c449ed86671e4a34a8b8b9430850beba+67108864 09fcfea01c3a141b89dd0dcfa1b7768e+22534144 0:89643008:Docker\040image.tar
 170 </pre>