Giter Club home page Giter Club logo

wot-terms's Introduction

What

WOT-terms

WOT is "WebofTrust". It's the home of all KERI-related open-source code. The umbrella term is KERI Suite. It covers KERI core, ACDC, CESR, OOBI, and all other parts.

What is this?

This repo manages the content and functionality of all concepts and terminology behind the KERI Suite. It offers a glossary with definitions and links to the terminology source management tools. It also feeds the dictionary tool Kerific.

Documentation subsystems and their technologies

  • This repo handles concepts and terminology resulting in a glossary run as a Docusaurus site (GitHub pages)
  • The KERI Suite documentation, which is also a Docusaurus site (GitHub pages)
  • The KERI Suite Search Engine, which is Typesense-based GitHub pages; custom-made Bootstrap.
  • The Kerific SSI dictionary: Self-Sovereign Identity dictionary including KERI terms (browser extension for Brave/Edge/Chrome).

WOT-terms

Is the data part of this site and consists of:

  • Glossary
  • Concepts behind the KERI Suite

Why

Clear criteria for term definitions around KERI are needed.

For who

The WOT-terms repo is primarily aimed at people trying to understand the inner workings of the KERI Suite and how the suite relates to other identifier systems in the SSI field.

Policy

See the documents in this repo titled LICENSE.md and CONTRIBUTING.md for licensing and contributing policy. Besides the IETF licensing terms, these include the comprehensive Apache2 license for all associated intellectual property (IP) including patents. The advantage of one comprehensive license for all contributions is that there will always be alignment between all contributors and for any type of contribution. This alignment includes an inbound=outbound policy for all related IP. We only want contributions to KERI made here in the WebOfTrust project that are licensed as free, and nonreciprocal open source be it software or specification.

Meetings

We have technical meetings twice a week on Monday and Thursdays.

The Edu Meetings held every other Thursday (First meeting was on 2022 July 28), stopped April 2023.

The meeting agenda of the Technical Meeting may be found here. The Zoom link is also at the top of that page.

Related Meetings

Technical

ACDC leverages KERI. The ACDC Task Force meeting is hosted at ToIP and meets on the alternate weeks at the same time as the KERI meetings. The ACDC meetings complement the KERI meetings. Both meetings are focussed on technicalities, specifications and code developments.

Conceptual

There also is the Concepts and terminology of Trust over IP. It's a meeting that aligns Trust over IP (North America) and eSSIF (Europe) efforts in getting understood: concepts, terminology and glossaries and importantly being able to use and reference each others work.

Install this project

This repo is a GitHub pages website based on Docusaurus that manages terminology through a source management tool, which currently is the wiki of WOT-terms.

This website is built in Docusaurus ( https://docusaurus.io ).

Run website

What should you do to install this project:

  • Run git clone url

  • Run npm install

  • Create .env based on .env.example and secret info

  • Now you can run a local version of the Docusaurus website: $ npx docusaurus start. The search engine also works now.

{ Kor, change link pls How we did } describes the follow-up steps.

Origin

Mid 2024 we've split up old WOT-terms repo into:

Apart from this, we still have:

  • kerific: SSI-terminology dictionary including KERI terms (browser extension for Brave/Edge/Chrome).

wot-terms's People

Contributors

2byrds avatar actions-user avatar daidoji avatar hackmd-deploy avatar henkvancann avatar kordwarshuis avatar pfeairheller avatar rieksj avatar seriouscoderone avatar trentlarson avatar

Stargazers

avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

Forkers

henkvancann kordwarshuis trentlarson 2byrds daidoji temucin

wot-terms's Issues

Introduce Collections in Typesense and add correct filters

To do Kor/Henk design: "show Type filter only for the glossary", glossary could have its own Typesense collection which would then also show the correct filters, so all others would not show "Type" filter.
The UI of the SE could offer these buttons for the various collections.
[All] (default) [Glossary only] [KERISSE only] [BLOGs only] [Whitepapers only].
A Typesense collection should keep track of its relevant filter-options.

KERI Suite Feedback: testing

How did you hear about KERI Suite?

via TrustoverIP

Which part of the KERI Suite was your angle to look for?

  • key management
  • crypto currency
  • Self Sovereign Identity
  • KERI
  • ACDC
  • CESR
  • OOBI
  • IPEX
  • PTEL
  • KERIA
  • SIGNIFY

Other Source

not applicable

What was the point of interest for you as a developer?

Just typing something

Roadmap of KERI and ACDC and go to place for a status report

Roadmap It’s important to realize this is about the KERI / ACDC roadmap and not our own roadmap in the Concepts-Terms-Edu group.

There is a central location or jump-off spot in the KERI repo; the README: https://github.com/WebOfTrust/keri

There's demand for a more detailed and accurate roadmap and continuous status report with links the right locations where (re)sources can be found.

Topics that are interesting in the approach to document this:
(Discussed Aug 25 2022 during Meetup)

  1. Ruth: What is and what is not implemented : Watcher service (Not), revocation (is, but not working)
  2. Joseph: where are we, so I could recommend certain parts or applications of KERI
  3. Steven: what’s GLEIF and what’s KERI?
  4. Kent: focus on Key management in the roadmap (+ storage / rotation )
  5. Kent: 3 stages: familiar with KERI -> easy CLI to demo -> to do a basic reference implementation
  6. Steven: 3 usecases for what hasn’t been created yet: what would you do with KERI if you had it?

This is the hackedmd.io file to start off with: https://hackmd.io/yYpd2uhRTpCadsGVw3Rl-A

Slackord import

The Slackord import tool version 3.0.3 has a bug for Mac OS. And it doesn't look that it's going to be repaired soon by the Slackord team.

So wanted: Microsoft Windows machine and someone who could assist getting the history into Discord?

I have the JSON version of the full Slack history download available. (Sent it to Kevin Griffin by email on Sept 26)

The request is to install Slackord version 3.0.3 for Windows and import the history into Discord.

@m00sey Would you want to give it a try? I can send you the full Slack history by PM. Slackord has a discord channel were the creator / maintainer is pretty swiftly responding once assistance should be needed.

To do:

Download and install:
https://github.com/thomasloupe/Slackord/releases/tag/v3.0.3

Follow / check the requirements (many of them I already implemented / configured on our Discord server)

Use the tool to import the history in JSON (unzip) that I've sent by e-mail.

Logged in users can't create a new page for the WOT-terms Wiki

Kent Bull
6:50 PM
I tried to add a term and didn’t see the button.

6:51
Where is the button supposed to be to add a page to the wiki?
6:53
I just tested something out on one of my repos. It looks like I’m missing the “New Page” button as below:
image (1)

Phil Feairheller
7:38 PM
KERISSE to the rescue!! We needed to add a term to the vLEI EGF Glossary and it was simple to use KERISSE to find the definition in the ToIP glossary and copy and paste it (edited)

Rodolfo Miranda
7:39 PM
I'm fan #1 of KERISSE !!!

Phil Feairheller
7:40 PM
Now we just need to add "ample" to its list of definitions 😂

Henk: Great! But … give us some time, there’s a user rights issue in the new location.

Objective: Mindmap items filled out

The concepts.md file has a twin: the mindmap, based on the same header structure (manually kept in sync), with links to the concepts.md file included.

Most paragraphs of the conceptual description has still to be written. Please feel free to start helping the reversed construction of a concepts page based on what actually available in white papers, technical designs and code, today.

As soon as a text is ready in the concepts file the link to the header in the mindmap can be added too.

KERI Suite Feedback:

How did you hear about KERI Suite?

at IIW

Other Source

No response

Which part of the KERI Suite was your angle to look for?

  • key management
  • crypto currency
  • Self Sovereign Identity
  • KERI
  • ACDC
  • CESR
  • OOBI
  • IPEX
  • PTEL
  • KERIA
  • SIGNIFY

What was the point of interest for you as a developer?

Beyond the comprehensive key management, the ACDC spec and other conversations show that this can be the foundation for secure data across a range of interoperable deployments (ie. simple building blocks that are not dependent on advanced cryptography).

Why did you become involved?

I want to build systems to generate credentials in an interoperable way.

How did you become involved?

Slowly, after seeing it at IIW a few times and hearing the discussions on calls and seeing other skilled, trusted people work on it.

How did you build up you knowledge?

Again, slowly: getting the system running with Kent Bull's (personal) assistance, reading and referencing the specs multiple times, lurking on calls.

How did you build up your skills?

I can't say I have many yet, but I want to experiment with the pieces (eg. generate CESR, generate some keys and sign and validate, generate ACDCs and validate).

What learning resources lacked?

Broken codebases. (At one point I was able to run keria & signify and test, but then that broke and IPEX was introduced as a necessity... and some people pointed my to specific commits that would work and I hear things work now but I haven't had the time and motivation to try again.)

What tips & tricks would you have for us?

I would put the "work through tutorials" first (unless the "introductory reading" is a single blog post that points to tutorials). We learn by doing, and that educational progression through the concepts is a tough presentation to create but would be immensely valuable.

KERI Suite Feedback:

How did you hear about KERI Suite?

via GitHub

Other Source

No response

Which part of the KERI Suite was your angle to look for?

  • key management
  • crypto currency
  • Self Sovereign Identity
  • KERI
  • ACDC
  • CESR
  • OOBI
  • IPEX
  • PTEL
  • KERIA
  • SIGNIFY

What was the point of interest for you as a developer?

It was because I've had a long running fascination with PKI systems and their challenges/benefits and I really liked the elegant nature of several of the key ideas KERI brought to the table. Namely key pre-rotation, SCIDs, and witnesses.

Why did you become involved?

Thought it was the best tech for a variety of things I wanted to build. So now I'm trying to gain experience and build them.

How did you become involved?

Just started coming to meetings in July of 2023 I think.

How did you build up you knowledge?

I read all the papers which I thought were pretty straightforward. Logically most of it makes sense even if I don't quite have the jargon down correctly. The toolchain though could use a lot of usability work and playing around with them and trying to just figure stuff out has been my main approach because as a community we still don't have a great set of tutorials or howtos other than some basic scripts.

How did you build up your skills?

Similar to above. Just tried playing around with things and building various prototypes/working on the codebases directly to solve bugs.

What learning resources lacked?

HOWTOs and tutorials on how to build the tools we already have and maybe roadmaps or tools that we need to have but no one has started to work on yet. Certainly, the community is a little insular at the moment.

I think that there exists the GLEIF technical recommendations which were really really really good from a security perspective (imo). If we could distill some of that into a "best practices" or a set of "security practices and KERI" I think it would really show just how super secure you can make KERI.

Also, a document or two on LMDB and HIO and architectural decisions of keripy would go a long way to helping developers get up to speed there.

What tips & tricks would you have for us?

That seems like pretty much what I did. The only comment I'd have is that we could do more as a community to make the above welcoming to newcomers. Probably everyone doesn't have time to dig into codebases and figure stuff out. Maybe a "learning path" like the above with tutorials/howtos/explainers would be good.

Broken Links Report

Created: 2023-10-09T03:35:28.316Z

Number of broken internal links: 8

See full list of broken internal links, or see below:

Broken Links Report

Created: 2023-10-09T03:35:28.316Z

Total Broken Links Found: 8

Link generation after parsing a raw text with a list of terms

A question you might know a direction of an answer to

henkvancann
9:08 PM
Based on a count of terms in a text or md file (e.g. a raw version of a whitepaper) I’d like to generate links into the text of that file.
So I have a two column list of terms and their links to the glossary and then a text is parsed to count the terms. And now I’d like to create a link on every N-th occurrence of all the terms (that doesn’t have a link yet), whereby N = Count / Divider, starting from the top of the document.
Question: have you ever seen someone has done it before?
New

Sid Haniff
9:10 PM
I haven’t no but what are you using to do the parsing?

henkvancann
9:11 PM
sed and awk
9:11
e.g.
☺️ cat testRL.txt gh-pages ✗
self-certifying identifier is a hash thing to escrow
public transaction event logs are nasty and http://event.com/public/transaction.md
9:11
#!/bin/bash

Purpose: Test link replacement with variables

Author: Henk van Cann

linky=“http://hier.komt.wat/nogiets.html”
tterm=“self-certifying identifier”
sed -r “s|(${tterm})+|\1|g” testRL.txt

Sid Haniff
9:12 PM
Ah I’ll have a look tomorrow … I’m logged off my computer now and just reading this on the phone

henkvancann
9:12 PM
Output:
self-certifying identifier is a hash thing to escrow
public transaction event logs are nasty and http://event.com/public/transaction.md
9:13
Pls don’t feel obliged, I just don’t like to reinvent wheels

Sid Haniff
9:13 PM
No sure it sounds interesting and happy to have a look / think

henkvancann
9:16 PM
This tool is the hardest last linking pin to get my head around and then I should be able to generate a text that contains many links to a glossary because a fuzzy search has found the links to it in raw plain text. From this I’d like to generate the sidebars as well like this example here: http://127.0.0.1:4000/WOT-terms/mydoc_about_ruby_gems_etc.htmlA question you might know a direction of an answer to

henkvancann
9:08 PM
Based on a count of terms in a text or md file (e.g. a raw version of a whitepaper) I’d like to generate links into the text of that file.
So I have a two column list of terms and their links to the glossary and then a text is parsed to count the terms. And now I’d like to create a link on every N-th occurrence of all the terms (that doesn’t have a link yet), whereby N = Count / Divider, starting from the top of the document.
Question: have you ever seen someone has done it before?
New

Sid Haniff
9:10 PM
I haven’t no but what are you using to do the parsing?

henkvancann
9:11 PM
sed and awk
9:11
e.g.

:relaxed: cat testRL.txt                                                          gh-pages ✗
self-certifying identifier is a hash thing to escrow
public transaction event logs are [nasty](nasty) and http://event.com/public/transaction.md

9:11

#!/bin/bash
# Purpose: Test link replacement with variables
# Author: Henk van Cann
linky=“http://hier.komt.wat/nogiets.html”
tterm=“self-certifying identifier”
sed -r “s|(${tterm})+|[\1](${linky})|g”  testRL.txt

Sid Haniff
9:12 PM
Ah I’ll have a look tomorrow … I’m logged off my computer now and just reading this on the phone

henkvancann
9:12 PM
Output:
self-certifying identifier is a hash thing to escrow
public transaction event logs are nasty and http://event.com/public/transaction.md
9:13
Pls don’t feel obliged, I just don’t like to reinvent wheels

Sid Haniff
9:13 PM
No sure it sounds interesting and happy to have a look / think

henkvancann
9:16 PM
This tool is the hardest last linking pin to get my head around and then I should be able to generate a text that contains many links to a glossary because a fuzzy search has found the links to it in raw plain text. From this I’d like to generate the sidebars as well like this example here: http://127.0.0.1:4000/WOT-terms/mydoc_about_ruby_gems_etc.html

What problem does ... solve?

KERI

Key management: Proving chain of custody over an identifier at any point in time

Key Management Infrastructure
a decentralized key management infrastructure based on key change events that supports both attestable key events and consensus based verification of key events.

Distributed multi-sig

Key management delegation -> to add an additional layer of approval with key rotation (or recovery) (< > issuance of credenitials , which is ACDC)

A Secure Identifier Overlay for the Internet (Samuel M. Smith Ph.D.)

Retake control of our data (source )

"It's Single Sign On on Steroïds; this is my end-all-be-all SSO for life”.
(Source Joseph Hunsaker)

It solves fraud with reputation - Philip Feairheller

“the autonomous control of authentic data and relationships." Timothy Ruff
https://rufftimo.medium.com/web3-web5-ssi-3870c298c7b4

ACDC

Secure attribution on the web (reputation)

Proof of authorship -
Proof of authority -
drivers license (electricity bills - not having to present paper + signed version of that proof attested by )

composability - combining and using them in different contexts

{TBW}

OOBI

Discovery via URI, trust via KERI: more efficiency, less vulnerability to hacks, purer self sovereignty, and middlemen cut out of the equation.
(Source )

CESR

Modern and secure digital data streaming over the web.
(source)

CESR is a dual text-binary encoding format that solves the readability vs performance problem of data encoding.

Problem: In general, currently there is no standard text-based encoding protocol that provides universal type, size, and value encoding for cryptographic primitives. Solution: CESR.

IPEX

The simplification of the IPEX protocol has two primary advantages.

  • The first is enhanced security. A well-delimited protocol can be designed and analyzed to minimize and mitigate attack mechanisms.
  • The second is convenience. A standard simple protocol is easier to implement, support, update, understand, and adopt.

SAID

facilitates greater interoperability, reduced ambiguity, and enhanced security when reasoning about the serialization. Moreover, given sufficient cryptographic strength, a cryptographic commitment such as a signature, digest, or another SAID, to a given SAID is essentially equivalent to a commitment to its associated serialization.

CESR-Proof

Signature outside the payload of the stream

Any KERI message -> streaming
Forwarding messages through mailboxen to other controllers is impossible without envelopes.

Embedding signatures into

DID-KERI

  • no namespace collisions anymore
  • uniform method "all equally secure & strong"

User levels integrated in content

We use WOT-terms tab LabelContent, data-level, data-type in .md files to:
- standard level 3, overrule with level 2 and level 1, which means: level2 includes level 1, level 3 includes all. Use data-level tags to exclude stuff in a higher (number) level.

We need to fulfil effort this per file and then if required per paragraph using div-tags.

Henk: frontmatter -> no we don't use this, too maintenance heavy

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.