2021-03-16 16:18:01 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Hole Book< / title >
< meta name = "robots" content = "noindex" / >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-03-16 16:24:02 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "Hole.html" > < strong aria-hidden = "true" > 1.< / strong > How it works< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "Message-flow.html" > < strong aria-hidden = "true" > 1.1.< / strong > Message flow< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "Protocol.html" > < strong aria-hidden = "true" > 2.< / strong > Protocol description< / a > < / li > < li class = "chapter-item expanded " > < a href = "API.html" > < strong aria-hidden = "true" > 3.< / strong > Frontend API< / a > < / li > < / ol >
2021-03-16 16:18:01 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > Hole Book< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2021-03-16 16:24:02 +00:00
< h1 id = "hole-chat" > < a class = "header" href = "#hole-chat" > Hole chat< / a > < / h1 >
2021-03-16 16:18:01 +00:00
< h1 id = "message-flow" > < a class = "header" href = "#message-flow" > Message flow< / a > < / h1 >
< p > < em > (pseudocode in Bash style)< / em > < / p >
< p > Hole receiving messages by looking for new items in " user's bin" (place where new messages arrives). Because of how freenet works, we can't just say " Hey! Do I have new messages?" , we can specify messages index like: " Hey! Gimme 15th message" . Thus we must remember previous message index and to receive the new message we're requesting for 16th message, if we was able to get 15th message.< / p >
< p > That's mean, what interlocutor also have to know the last message index in our bin. But < strong > how he can know it, if there's a lot of other users who also sending messages to our bin?< / strong > Of course, you can try to receive all messages from the index, you had last remembered, and next index, next, next... until you find the index which does not exist. But it's a freenet, it's take too much time;< / p >
< p > The solution is unique Id. User creating and giving his/her unique id to each new interlocutor. And when, if interlocutor sending the message he knows, that last message to us had index < code > $N< / code > and sends message with index < code > $N+1< / code > , if be more verbose, the new message index he send to us will look like < code > " $(ID)_($N+1)" < / code > < / p >
< h1 id = "hole-protocol" > < a class = "header" href = "#hole-protocol" > Hole Protocol< / a > < / h1 >
< h2 id = "process-of-messaging" > < a class = "header" href = "#process-of-messaging" > Process of messaging< / a > < / h2 >
< p > Each user have kind of a bin among freenet network,in which anyone can put message. And for each user this bin is his < code > USK insert< / code > key. Each message signed by sender. And user can answer to sender, buy putting message at sender insert key if he know it.< / p >
< h2 id = "user-ids" > < a class = "header" href = "#user-ids" > user IDs< / a > < / h2 >
< p > Each user have unique pseudonym for each user whom he communicates. Thos pseudonyms uses by user to identify who is sender end establish message flow.
The " message flow" is important here.< / p >
< ul >
< li > < input disabled = "" type = "checkbox" / >
Probably, for each pair of each people we will < strong > not only one< / strong > unique identifier but... I'm not going to do it in further releases. < em > TODO< / em > < / li >
< / ul >
< h2 id = "message-request" > < a class = "header" href = "#message-request" > Message request< / a > < / h2 >
< p > To receive a new message we have to send < code > ClientGet< / code > to our < code > USK request< / code > key with URI like < code > /user_id-message_version< / code > . As well, the identifier is consists of < code > user_id-message_number< / code >
For example:< / p >
< pre > < code class = "language-Bash" > ClientGet
URI=USK@myMessageBinKey/messages/user5678-3
Identifier=request-user5678-3
Verbosity=0
ReturnType=direct
EndMessage
< / code > < / pre >
< h2 id = "message-sending" > < a class = "header" href = "#message-sending" > Message sending< / a > < / h2 >
< p > To send a message to a friend we putting it at his < code > USK insert< / code > key, with URI like< code > /my_id-$(number_of_messages_to_this_user + 1)< / code > . And identifier like < code > user_id-$(number_of_messages_to_this_user + 1)< / code >
For example:< / p >
< pre > < code class = "language-Bash" > ClientGet
URI=USK@myFriendBinKey/messages/user3246-5
Identifier=user3501-5
Verbosity=0
ReturnType=direct
EndMessage
< / code > < / pre >
< h2 id = "adding-friend" > < a class = "header" href = "#adding-friend" > Adding friend< / a > < / h2 >
< p > Hole generates file, which alice have to send to bob somehow, and bob have to do the same. This file will contain unique ID and two keys< / p >
< h1 id = "hole-frontend-api" > < a class = "header" href = "#hole-frontend-api" > Hole Frontend API< / a > < / h1 >
2021-04-16 15:46:58 +00:00
<!-- ## Loginning and Registration -->
<!-- ### Registration request -->
<!-- On base of password will be generted keypair for signing and keypair for encoding. -->
<!-- ``` json -->
<!-- { -->
<!-- request_type: "registration", -->
<!-- username: "user", -->
<!-- password: "passwd123", -->
<!-- } -->
<!-- ``` -->
<!-- ### Login request -->
<!-- ```json -->
<!-- { -->
<!-- request_type: login, -->
<!-- username: "name", -->
<!-- decode_key: "key", -->
<!-- sign_key: "key", -->
<!-- } -->
<!-- ``` -->
<!-- ## Adding friends -->
<!-- Each user have :w -->
< hr / >
< h1 id = "requests" > < a class = "header" href = "#requests" > Requests< / a > < / h1 >
< pre > < code class = "language-Rust" > pub enum Request {
StartApp,
StopApp,
LoadUsers,
#[serde(rename_all = " camelCase" )]
SendMessage {
user_id: Id,
message: String,
},
#[serde(rename_all = " camelCase" )]
LoadMessages {
user_id: Id,
count: u32,
start_index: u32,
},
#[serde(rename_all = " camelCase" )]
AddUser {
name: String,
sign_key: String,
insert_key: String,
}, // CreateInstance TODO v0.3
}
2021-03-16 16:18:01 +00:00
< / code > < / pre >
2021-04-16 15:46:58 +00:00
< h2 id = "startapp" > < a class = "header" href = "#startapp" > < code > StartApp< / code > < / a > < / h2 >
< p > Require when when client started.< / p >
< pre > < code class = "language-json" > {
type: " startApp"
}
< / code > < / pre >
< h2 id = "stopapp" > < a class = "header" href = "#stopapp" > < code > StopApp< / code > < / a > < / h2 >
< pre > < code class = "language-json" > {
type: " stopApp"
}
< / code > < / pre >
< h2 id = "loadusers" > < a class = "header" href = "#loadusers" > < code > LoadUsers< / code > < / a > < / h2 >
< pre > < code class = "language-json" > {
type: " loadUsers"
}
< / code > < / pre >
< h2 id = "sendmessage" > < a class = "header" href = "#sendmessage" > < code > SendMessage< / code > < / a > < / h2 >
< pre > < code class = "language-json" > {
type: " sendMessage" ,
userId: " UUID_V4..." ,
message: " hellow world"
}
< / code > < / pre >
< h2 id = "adduser" > < a class = "header" href = "#adduser" > < code > AddUser< / code > < / a > < / h2 >
< pre > < code class = "language-json" > {
type: " addUser" ,
name: " username" ,
signKey: " USK@key..." ,
insertKey: " insertkey..."
}
< / code > < / pre >
< h2 id = "loadmessages" > < a class = "header" href = "#loadmessages" > < code > LoadMessages< / code > < / a > < / h2 >
< p > Requesting < code > count< / code > messages from < code > userId< / code > started from < code > startIndex< / code > 's message< / p >
< pre > < code class = "language-json" > {
type: " loadMessages" ,
userId: " UUID_V4..." ,
count: 10,
startIndex: 30
}
2021-03-16 16:18:01 +00:00
< / code > < / pre >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< / nav >
< / div >
<!-- Livereload script (if served using the cli tool) -->
< script type = "text/javascript" >
var socket = new WebSocket("ws://localhost:3000/__livereload");
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
socket.close();
}
< / script >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" >
window.addEventListener('load', function() {
window.setTimeout(window.print, 100);
});
< / script >
< / body >
< / html >
