951 lines
78 KiB
HTML
951 lines
78 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<!-- Favicon -->
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- CSS -->
|
|
<title>libp2p/crypto/ed25519/ed25519</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../nimdoc.out.css">
|
|
|
|
<script type="text/javascript" src="../../../dochack.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
function main() {
|
|
var pragmaDots = document.getElementsByClassName("pragmadots");
|
|
for (var i = 0; i < pragmaDots.length; i++) {
|
|
pragmaDots[i].onclick = function(event) {
|
|
// Hide tease
|
|
event.target.parentNode.style.display = "none";
|
|
// Show actual
|
|
event.target.parentNode.nextElementSibling.style.display = "inline";
|
|
}
|
|
}
|
|
|
|
function switchTheme(e) {
|
|
if (e.target.checked) {
|
|
document.documentElement.setAttribute('data-theme', 'dark');
|
|
localStorage.setItem('theme', 'dark');
|
|
} else {
|
|
document.documentElement.setAttribute('data-theme', 'light');
|
|
localStorage.setItem('theme', 'light');
|
|
}
|
|
}
|
|
|
|
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
|
if (toggleSwitch !== null) {
|
|
toggleSwitch.addEventListener('change', switchTheme, false);
|
|
}
|
|
|
|
var currentTheme = localStorage.getItem('theme');
|
|
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
|
currentTheme = 'dark';
|
|
}
|
|
if (currentTheme) {
|
|
document.documentElement.setAttribute('data-theme', currentTheme);
|
|
|
|
if (currentTheme === 'dark' && toggleSwitch !== null) {
|
|
toggleSwitch.checked = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
window.addEventListener('DOMContentLoaded', main);
|
|
</script>
|
|
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">libp2p/crypto/ed25519/ed25519</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-switch-wrapper">
|
|
<label class="theme-switch" for="checkbox">
|
|
<input type="checkbox" id="checkbox" />
|
|
<div class="slider round"></div>
|
|
</label>
|
|
<em>Dark Mode</em>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple">
|
|
<li>
|
|
<a href="../../../theindex.html">Index</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="text" id="searchInput"
|
|
onkeyup="search()" />
|
|
</div>
|
|
<div>
|
|
Group by:
|
|
<select onchange="groupBy(this.value)">
|
|
<option value="section">Section</option>
|
|
<option value="type">Type</option>
|
|
</select>
|
|
</div>
|
|
<script type="text/javascript">
|
|
function main2() {
|
|
// Create the slider
|
|
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
|
|
var newSlider = document.createRange().createContextualFragment(`
|
|
<div class="theme-switch-wrapper">
|
|
<label class="theme-switch" for="internalcheckbox">
|
|
<input type="checkbox" id="internalcheckbox">
|
|
<div class="slider round"></div>
|
|
</label>
|
|
<em>Internal</em>
|
|
</div>
|
|
`);
|
|
|
|
var sliderInst = firstSlider.after(newSlider);
|
|
|
|
// Restore slider state from storage
|
|
var currentMode = localStorage.getItem('privateMode');
|
|
if (currentMode == "private") {
|
|
document.getElementById("internalcheckbox").checked = true;
|
|
} else {
|
|
hidePrivateProcs();
|
|
}
|
|
|
|
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
|
|
}
|
|
|
|
function hidePrivateProcs() {
|
|
var toHide = document.getElementsByClassName("tohide");
|
|
for (var i = 0; i < toHide.length; i++) {
|
|
var pragmas = toHide[i].querySelectorAll("span.Identifier");
|
|
var public = false;
|
|
for (var z = 0; z < pragmas.length; z++) {
|
|
if (pragmas[z].innerText == "public") {
|
|
public = true;
|
|
break;
|
|
}
|
|
}
|
|
if (public == false) {
|
|
toHide[i].style.display = "none";
|
|
toHide[i].classList.add("hidden");
|
|
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
|
|
for (var y = 0; y < links.length; y++) {
|
|
links[y].parentNode.style.display = "none";
|
|
links[y].parentNode.classList.add("hidden");
|
|
}
|
|
}
|
|
}
|
|
|
|
// TOC
|
|
var nestedSections = document.getElementsByClassName("nested-toc-section");
|
|
for (var i = 0; i < nestedSections.length; i++) {
|
|
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
|
|
nestedSections[i].style.display = "none";
|
|
nestedSections[i].classList.add("hidden");
|
|
}
|
|
}
|
|
|
|
var sections = document.getElementsByClassName("simple-toc-section");
|
|
for (var i = 0; i < sections.length; i++) {
|
|
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
|
|
sections[i].parentNode.style.display = "none";
|
|
sections[i].parentNode.classList.add("hidden");
|
|
}
|
|
|
|
}
|
|
|
|
// Sections
|
|
var sections = document.getElementsByClassName("section");
|
|
for (var i = 0; i < sections.length; i++) {
|
|
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
|
|
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
|
|
sections[i].style.display = "none";
|
|
sections[i].classList.add("hidden");
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
function showPrivateProcs() {
|
|
var toHide = Array.from(document.getElementsByClassName("hidden"));
|
|
for (var i = 0; i < toHide.length; i++) {
|
|
toHide[i].style.display = "";
|
|
toHide[i].classList.remove("hidden");
|
|
}
|
|
}
|
|
|
|
function togglePrivateProcs() {
|
|
if (document.getElementById("internalcheckbox").checked) {
|
|
localStorage.setItem('privateMode', 'private');
|
|
showPrivateProcs();
|
|
} else {
|
|
localStorage.setItem('privateMode', 'public');
|
|
hidePrivateProcs();
|
|
}
|
|
}
|
|
window.addEventListener("DOMContentLoaded", main2);
|
|
</script>
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
<ul class="simple simple-toc-section">
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#EdError"
|
|
title="EdError = enum
|
|
EdIncorrectError">EdError</a></li>
|
|
<li><a class="reference" href="#EdKeyPair"
|
|
title="EdKeyPair = object
|
|
seckey*: EdPrivateKey
|
|
pubkey*: EdPublicKey">EdKeyPair</a></li>
|
|
<li><a class="reference" href="#EdPrivateKey"
|
|
title="EdPrivateKey = object
|
|
data*: array[EdPrivateKeySize, byte]">EdPrivateKey</a></li>
|
|
<li><a class="reference" href="#EdPublicKey"
|
|
title="EdPublicKey = object
|
|
data*: array[EdPublicKeySize, byte]">EdPublicKey</a></li>
|
|
<li><a class="reference" href="#EdSignature"
|
|
title="EdSignature = object
|
|
data*: array[EdSignatureSize, byte]">EdSignature</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#EdPrivateKeySize"
|
|
title="EdPrivateKeySize = 64">EdPrivateKeySize</a></li>
|
|
<li><a class="reference" href="#EdPublicKeySize"
|
|
title="EdPublicKeySize = 32">EdPublicKeySize</a></li>
|
|
<li><a class="reference" href="#EdSignatureSize"
|
|
title="EdSignatureSize = 64">EdSignatureSize</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">$
|
|
<li><a class="reference" href="#%24%2CEdPrivateKey"
|
|
title="`$`(key: EdPrivateKey): string">`$`(key: EdPrivateKey): string</a></li>
|
|
<li><a class="reference" href="#%24%2CEdPublicKey"
|
|
title="`$`(key: EdPublicKey): string">`$`(key: EdPublicKey): string</a></li>
|
|
<li><a class="reference" href="#%24%2CEdSignature"
|
|
title="`$`(sig: EdSignature): string">`$`(sig: EdSignature): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">==
|
|
<li><a class="reference" href="#%3D%3D%2CEdPrivateKey%2CEdPrivateKey"
|
|
title="`==`(eda, edb: EdPrivateKey): bool">`==`(eda, edb: EdPrivateKey): bool</a></li>
|
|
<li><a class="reference" href="#%3D%3D%2CEdPublicKey%2CEdPublicKey"
|
|
title="`==`(eda, edb: EdPublicKey): bool">`==`(eda, edb: EdPublicKey): bool</a></li>
|
|
<li><a class="reference" href="#%3D%3D%2CEdSignature%2CEdSignature"
|
|
title="`==`(eda, edb: EdSignature): bool">`==`(eda, edb: EdSignature): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">checkScalar
|
|
<li><a class="reference" href="#checkScalar%2CopenArray%5Bbyte%5D"
|
|
title="checkScalar(scalar: openArray[byte]): uint32">checkScalar(scalar: openArray[byte]): uint32</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">clear
|
|
<li><a class="reference" href="#clear%2CEdPrivateKey"
|
|
title="clear(key: var EdPrivateKey)">clear(key: var EdPrivateKey)</a></li>
|
|
<li><a class="reference" href="#clear%2CEdPublicKey"
|
|
title="clear(key: var EdPublicKey)">clear(key: var EdPublicKey)</a></li>
|
|
<li><a class="reference" href="#clear%2CEdKeyPair"
|
|
title="clear(pair: var EdKeyPair)">clear(pair: var EdKeyPair)</a></li>
|
|
<li><a class="reference" href="#clear%2CEdSignature"
|
|
title="clear(sig: var EdSignature)">clear(sig: var EdSignature)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getBytes
|
|
<li><a class="reference" href="#getBytes%2CEdPrivateKey"
|
|
title="getBytes(key: EdPrivateKey): seq[byte]">getBytes(key: EdPrivateKey): seq[byte]</a></li>
|
|
<li><a class="reference" href="#getBytes%2CEdPublicKey"
|
|
title="getBytes(key: EdPublicKey): seq[byte]">getBytes(key: EdPublicKey): seq[byte]</a></li>
|
|
<li><a class="reference" href="#getBytes%2CEdSignature"
|
|
title="getBytes(sig: EdSignature): seq[byte]">getBytes(sig: EdSignature): seq[byte]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getPublicKey
|
|
<li><a class="reference" href="#getPublicKey%2CEdPrivateKey"
|
|
title="getPublicKey(key: EdPrivateKey): EdPublicKey">getPublicKey(key: EdPrivateKey): EdPublicKey</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">init
|
|
<li><a class="reference" href="#init%2CEdPrivateKey%2CopenArray%5Bbyte%5D"
|
|
title="init(key: var EdPrivateKey; data: openArray[byte]): bool">init(key: var EdPrivateKey; data: openArray[byte]): bool</a></li>
|
|
<li><a class="reference" href="#init%2CEdPrivateKey%2Cstring"
|
|
title="init(key: var EdPrivateKey; data: string): bool">init(key: var EdPrivateKey; data: string): bool</a></li>
|
|
<li><a class="reference" href="#init%2CEdPublicKey%2CopenArray%5Bbyte%5D"
|
|
title="init(key: var EdPublicKey; data: openArray[byte]): bool">init(key: var EdPublicKey; data: openArray[byte]): bool</a></li>
|
|
<li><a class="reference" href="#init%2CEdPublicKey%2Cstring"
|
|
title="init(key: var EdPublicKey; data: string): bool">init(key: var EdPublicKey; data: string): bool</a></li>
|
|
<li><a class="reference" href="#init%2CEdSignature%2CopenArray%5Bbyte%5D"
|
|
title="init(sig: var EdSignature; data: openArray[byte]): bool">init(sig: var EdSignature; data: openArray[byte]): bool</a></li>
|
|
<li><a class="reference" href="#init%2CEdSignature%2Cstring"
|
|
title="init(sig: var EdSignature; data: string): bool">init(sig: var EdSignature; data: string): bool</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdPrivateKey%5D%2CopenArray%5Bbyte%5D"
|
|
title="init(t: typedesc[EdPrivateKey]; data: openArray[byte]): Result[EdPrivateKey,
|
|
EdError]">init(t: typedesc[EdPrivateKey]; data: openArray[byte]): Result[EdPrivateKey,
|
|
EdError]</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdPrivateKey%5D%2Cstring"
|
|
title="init(t: typedesc[EdPrivateKey]; data: string): Result[EdPrivateKey, EdError]">init(t: typedesc[EdPrivateKey]; data: string): Result[EdPrivateKey, EdError]</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdPublicKey%5D%2CopenArray%5Bbyte%5D"
|
|
title="init(t: typedesc[EdPublicKey]; data: openArray[byte]): Result[EdPublicKey,
|
|
EdError]">init(t: typedesc[EdPublicKey]; data: openArray[byte]): Result[EdPublicKey,
|
|
EdError]</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdPublicKey%5D%2Cstring"
|
|
title="init(t: typedesc[EdPublicKey]; data: string): Result[EdPublicKey, EdError]">init(t: typedesc[EdPublicKey]; data: string): Result[EdPublicKey, EdError]</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdSignature%5D%2CopenArray%5Bbyte%5D"
|
|
title="init(t: typedesc[EdSignature]; data: openArray[byte]): Result[EdSignature,
|
|
EdError]">init(t: typedesc[EdSignature]; data: openArray[byte]): Result[EdSignature,
|
|
EdError]</a></li>
|
|
<li><a class="reference" href="#init%2Ctypedesc%5BEdSignature%5D%2Cstring"
|
|
title="init(t: typedesc[EdSignature]; data: string): Result[EdSignature, EdError]">init(t: typedesc[EdSignature]; data: string): Result[EdSignature, EdError]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">random
|
|
<li><a class="reference" href="#random%2Ctypedesc%5BEdKeyPair%5D%2CHmacDrbgContext"
|
|
title="random(t: typedesc[EdKeyPair]; rng: var HmacDrbgContext): EdKeyPair">random(t: typedesc[EdKeyPair]; rng: var HmacDrbgContext): EdKeyPair</a></li>
|
|
<li><a class="reference" href="#random%2Ctypedesc%5BEdPrivateKey%5D%2CHmacDrbgContext"
|
|
title="random(t: typedesc[EdPrivateKey]; rng: var HmacDrbgContext): EdPrivateKey">random(t: typedesc[EdPrivateKey]; rng: var HmacDrbgContext): EdPrivateKey</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">sign
|
|
<li><a class="reference" href="#sign%2CEdPrivateKey%2CopenArray%5BT%5D"
|
|
title="sign[T: byte | char](key: EdPrivateKey; message: openArray[T]): EdSignature">sign[T: byte | char](key: EdPrivateKey; message: openArray[T]): EdSignature</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">toBytes
|
|
<li><a class="reference" href="#toBytes%2CEdPrivateKey%2CopenArray%5Bbyte%5D"
|
|
title="toBytes(key: EdPrivateKey; data: var openArray[byte]): int">toBytes(key: EdPrivateKey; data: var openArray[byte]): int</a></li>
|
|
<li><a class="reference" href="#toBytes%2CEdPublicKey%2CopenArray%5Bbyte%5D"
|
|
title="toBytes(key: EdPublicKey; data: var openArray[byte]): int">toBytes(key: EdPublicKey; data: var openArray[byte]): int</a></li>
|
|
<li><a class="reference" href="#toBytes%2CEdSignature%2CopenArray%5Bbyte%5D"
|
|
title="toBytes(sig: EdSignature; data: var openArray[byte]): int">toBytes(sig: EdSignature; data: var openArray[byte]): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">verify
|
|
<li><a class="reference" href="#verify%2CEdSignature%2CopenArray%5BT%5D%2CEdPublicKey"
|
|
title="verify[T: byte | char](sig: EdSignature; message: openArray[T]; key: EdPublicKey): bool">verify[T: byte | char](sig: EdSignature; message: openArray[T]; key: EdPublicKey): bool</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
<div class="nine columns" id="content">
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc">This module implements ED25519. This code is a port of the public domain, "ref10" implementation of ed25519 from SUPERCOP.</p>
|
|
<div class="section" id="6">
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
<dl class="item">
|
|
<a class="reference external" href="constants.html">constants</a>, <a class="reference external" href="../../utility.html">../../utility</a>
|
|
</dl></div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="EdError" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<span class="Identifier">EdIncorrectError</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L52"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L52" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdKeyPair" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdKeyPair"><span class="Identifier">EdKeyPair</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">seckey</span><span class="Operator">*</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a>
|
|
<span class="Identifier">pubkey</span><span class="Operator">*</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L48"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L48" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdPrivateKey" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="Identifier">EdPrivateKeySize</span><span class="Other">,</span> <span class="Identifier">byte</span><span class="Other">]</span>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L39"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdPublicKey" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="Identifier">EdPublicKeySize</span><span class="Other">,</span> <span class="Identifier">byte</span><span class="Other">]</span>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L42"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdSignature" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
|
|
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="Identifier">EdSignatureSize</span><span class="Other">,</span> <span class="Identifier">byte</span><span class="Other">]</span>
|
|
</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L45"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl></div>
|
|
<div class="section" id="10">
|
|
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
|
<dl class="item">
|
|
<div id="EdPrivateKeySize" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdPrivateKeySize"><span class="Identifier">EdPrivateKeySize</span></a> <span class="Other">=</span> <span class="DecNumber">64</span></pre></dt>
|
|
<dd>
|
|
|
|
Size in octets (bytes) of serialized ED25519 private key.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L31"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdPublicKeySize" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdPublicKeySize"><span class="Identifier">EdPublicKeySize</span></a> <span class="Other">=</span> <span class="DecNumber">32</span></pre></dt>
|
|
<dd>
|
|
|
|
Size in octets (bytes) of serialized ED25519 public key.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L33"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="EdSignatureSize" class="tohide">
|
|
<dt><pre><a href="ed25519.html#EdSignatureSize"><span class="Identifier">EdSignatureSize</span></a> <span class="Other">=</span> <span class="DecNumber">64</span></pre></dt>
|
|
<dd>
|
|
|
|
Size in octets (bytes) of serialized ED25519 signature.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L35"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl></div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="$,EdPrivateKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CEdPrivateKey"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Return string representation of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1744"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1744" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="$,EdPublicKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CEdPublicKey"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Return string representation of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1748"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1748" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="$,EdSignature" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CEdSignature"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Return string representation of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1752"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1752" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="==,EdPrivateKey,EdPrivateKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CEdPrivateKey%2CEdPrivateKey"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">eda</span><span class="Other">,</span> <span class="Identifier">edb</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Compare ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> objects for equality.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1732"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1732" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="==,EdPublicKey,EdPublicKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CEdPublicKey%2CEdPublicKey"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">eda</span><span class="Other">,</span> <span class="Identifier">edb</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Compare ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> objects for equality.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1736"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1736" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="==,EdSignature,EdSignature" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CEdSignature%2CEdSignature"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">eda</span><span class="Other">,</span> <span class="Identifier">edb</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Compare ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> objects for equality.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1740"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1740" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="checkScalar,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#checkScalar%2CopenArray%5Bbyte%5D"><span class="Identifier">checkScalar</span></a><span class="Other">(</span><span class="Identifier">scalar</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1639"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1639" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="clear,EdPrivateKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#clear%2CEdPrivateKey"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Wipe and clear memory of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1867"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1867" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="clear,EdPublicKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#clear%2CEdPublicKey"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Wipe and clear memory of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1871"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1871" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="clear,EdKeyPair" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#clear%2CEdKeyPair"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">pair</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdKeyPair"><span class="Identifier">EdKeyPair</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Wipe and clear memory of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span> <span class="Identifier">pair</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1879"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1879" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="clear,EdSignature" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#clear%2CEdSignature"><span class="Identifier">clear</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Wipe and clear memory of ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1875"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1875" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getBytes,EdPrivateKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getBytes%2CEdPrivateKey"><span class="Identifier">getBytes</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> and return it.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1723"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1723" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getBytes,EdPublicKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getBytes%2CEdPublicKey"><span class="Identifier">getBytes</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> and return it.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1726"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1726" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getBytes,EdSignature" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getBytes%2CEdSignature"><span class="Identifier">getBytes</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> and return it.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1729"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1729" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getPublicKey,EdPrivateKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getPublicKey%2CEdPrivateKey"><span class="Identifier">getPublicKey</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Calculate and return ED25519 public key from private key <tt class="docutils literal"><span class="pre">key</span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1689"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1689" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdPrivateKey,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdPrivateKey%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1756"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1756" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdPrivateKey,string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdPrivateKey%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1786"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1786" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdPublicKey,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdPublicKey%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1766"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1766" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdPublicKey,string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdPublicKey%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1793"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1793" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdSignature,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdSignature%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> <tt class="docutils literal"><span class="pre">sig</span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1776"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1776" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,EdSignature,string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CEdSignature%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> <tt class="docutils literal"><span class="pre">sig</span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns <tt class="docutils literal"><span class="pre">true</span></tt> on success.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1800"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1800" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdPrivateKey],openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdPrivateKey%5D%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span>
|
|
<a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">,</span> <a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1807"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1807" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdPrivateKey],string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdPrivateKey%5D%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">,</span> <a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1837"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1837" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdPublicKey],openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdPublicKey%5D%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">,</span>
|
|
<a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1817"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1817" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdPublicKey],string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdPublicKey%5D%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">,</span> <a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1847"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1847" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdSignature],openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdSignature%5D%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">,</span>
|
|
<a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> from raw binary representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1827"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1827" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="init,typedesc[EdSignature],string" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEdSignature%5D%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">,</span> <a href="ed25519.html#EdError"><span class="Identifier">EdError</span></a><span class="Other">]</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Initialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt> and return constructed object.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1857"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1857" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="random,typedesc[EdKeyPair],HmacDrbgContext" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#random%2Ctypedesc%5BEdKeyPair%5D%2CHmacDrbgContext"><span class="Identifier">random</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdKeyPair"><span class="Identifier">EdKeyPair</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">rng</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">HmacDrbgContext</span><span class="Other">)</span><span class="Other">:</span> <a href="ed25519.html#EdKeyPair"><span class="Identifier">EdKeyPair</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Generate new random ED25519 private and public keypair using OS specific CSPRNG.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1670"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1670" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="random,typedesc[EdPrivateKey],HmacDrbgContext" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#random%2Ctypedesc%5BEdPrivateKey%5D%2CHmacDrbgContext"><span class="Identifier">random</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">rng</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">HmacDrbgContext</span><span class="Other">)</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Generate new random ED25519 private key using the given random number generator
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1651"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1651" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sign,EdPrivateKey,openArray[T]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#sign%2CEdPrivateKey%2CopenArray%5BT%5D"><span class="Identifier">sign</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">byte</span> <span class="Operator">|</span> <span class="Identifier">char</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">noinit</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Create ED25519 signature of data <tt class="docutils literal"><span class="pre">message</span></tt> using private key <tt class="docutils literal"><span class="pre">key</span></tt>.
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1884"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1884" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="toBytes,EdPrivateKey,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#toBytes%2CEdPrivateKey%2CopenArray%5Bbyte%5D"><span class="Identifier">toBytes</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPrivateKey"><span class="Identifier">EdPrivateKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">private</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> to raw binary form and store it to <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns number of bytes (octets) needed to store ED25519 private key.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1693"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1693" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="toBytes,EdPublicKey,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#toBytes%2CEdPublicKey%2CopenArray%5Bbyte%5D"><span class="Identifier">toBytes</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">public</span> <span class="Identifier">key</span></span></tt> <tt class="docutils literal"><span class="pre">key</span></tt> to raw binary form and store it to <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns number of bytes (octets) needed to store ED25519 public key.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1703"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1703" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="toBytes,EdSignature,openArray[byte]" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#toBytes%2CEdSignature%2CopenArray%5Bbyte%5D"><span class="Identifier">toBytes</span></a><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Serialize ED25519 <tt class="docutils literal"><span class="pre"><span class="Identifier">signature</span></span></tt> <tt class="docutils literal"><span class="pre">sig</span></tt> to raw binary form and store it to <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
|
|
<p>Procedure returns number of bytes (octets) needed to store ED25519 signature.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1713"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1713" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="verify,EdSignature,openArray[T],EdPublicKey" class="tohide">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#verify%2CEdSignature%2CopenArray%5BT%5D%2CEdPublicKey"><span class="Identifier">verify</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">byte</span> <span class="Operator">|</span> <span class="Identifier">char</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">sig</span><span class="Other">:</span> <a href="ed25519.html#EdSignature"><span class="Identifier">EdSignature</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span>
|
|
<span class="Identifier">key</span><span class="Other">:</span> <a href="ed25519.html#EdPublicKey"><span class="Identifier">EdPublicKey</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>Verify ED25519 signature <tt class="docutils literal"><span class="pre">sig</span></tt> using public key <tt class="docutils literal"><span class="pre">key</span></tt> and data <tt class="docutils literal"><span class="pre">message</span></tt>.</p>
|
|
<p>Return <tt class="docutils literal"><span class="pre">true</span></tt> if message verification succeeded, <tt class="docutils literal"><span class="pre">false</span></tt> if verification failed.</p>
|
|
|
|
<a
|
|
href="https://github.com/status-im/nim-libp2p/tree/ex-logall/libp2p/crypto/ed25519/ed25519.nim#L1918"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/crypto/ed25519/ed25519.nim#L1918" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl></div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row">
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br/>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-01 13:15:44 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|