From 66a8b47b797622fc599fb89ac5596131428eaf92 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Fri, 19 Feb 2021 06:42:52 +0100 Subject: [PATCH 1/7] fix: [service] broken link fixed --- services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/services.md b/services.md index 367812f..1b544cb 100644 --- a/services.md +++ b/services.md @@ -10,4 +10,4 @@ intro_image_hide_on_mobile: false CyCAT will provide a public catalogue including an open API. The alpha version of the system is planned to be launched during the next EU ATT&CK Community workshop, on 1 June 2021. -We are currently in the initial feedback and peer review phase of the [White Paper](services/whitepaper/) and the [draft taxonomy](https://github.com/CyCat-project/cycat-taxonomy) behind the concept. This phase will end on 31 March 2021 and then we'll set out to build the aforementioned alpha version. +We are currently in the initial feedback and peer review phase of the [White Paper](whitepaper/) and the [draft taxonomy](https://github.com/CyCat-project/cycat-taxonomy) behind the concept. This phase will end on 31 March 2021 and then we'll set out to build the aforementioned alpha version. From 0ed070631a72e82c83f94add64720918485e793e Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Fri, 19 Feb 2021 07:04:47 +0100 Subject: [PATCH 2/7] new: [concept] first draft of the CyCAT url including publisher and project minimal required fields. --- _services/concept.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 _services/concept.md diff --git a/_services/concept.md b/_services/concept.md new file mode 100644 index 0000000..d7f090c --- /dev/null +++ b/_services/concept.md @@ -0,0 +1,43 @@ +--- +title: "CyCAT - Core Concept" +date: 2021-02-19T01:33:46+10:00 +featured: true +weight: 1 +layout: service +--- + +# Concept of CyCAT url + +A CyCAT url is composed of a publisher short name, a project short name and the associated UUID of the specific item. An item can be any part of the collection produced +by this publisher under a specific project. The CyCAT url is composed of two namespaces separated by colon and a final UUID appended after a colon. The CyCAT url is in UTF-8 format. + +`publisher-short-name`:`project-short-name`:`UUID` + +## Publisher + +A publisher can be any organisation, project or individual requesting a publisher to CyCAT. + +| Field name | Description | Required | +| ------------- |:---------------------------| ---------:| +| `name` | Name of the publisher (full name)| :heavy_check_mark: | +| `short-name` | Name of the publisher (short name) | :heavy_check_mark: | +| `description` | Description of the publisher | :heavy_check_mark: | +| `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | +| `link` | Internet link referencing the publisher | :heavy_check_mark: | + +Publisher examples: `mitre`, `circl`, `misp` + +## Project + +A publisher can request one or more project to CyCAT associated to the publisher namespace. + +| Field name | Description | Required | +| ------------- |:---------------------------| ---------:| +| `name` | Name of the project (full name)| :heavy_check_mark: | +| `short-name` | Name of the project (short name) | :heavy_check_mark: | +| `description` | Description of the project | :heavy_check_mark: | +| `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | +| `link` | Internet link referencing the project | :heavy_check_mark: | +| `license` | License(s) of the project in SPX identifier (array) | :heavy_check_mark: | +| `type` | [Taxonomy type](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | +| `scope` | [Taxonomy scope](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | From d82a8dfb0f9a98c4690606e8118121f699a1e78d Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Fri, 19 Feb 2021 09:22:12 +0100 Subject: [PATCH 3/7] Update concept.md --- _services/concept.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_services/concept.md b/_services/concept.md index d7f090c..229d458 100644 --- a/_services/concept.md +++ b/_services/concept.md @@ -24,6 +24,7 @@ A publisher can be any organisation, project or individual requesting a publishe | `description` | Description of the publisher | :heavy_check_mark: | | `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | | `link` | Internet link referencing the publisher | :heavy_check_mark: | +| `timestamp` | Last update of the publisher record (unix timestamp) | :heavy_check_mark: | Publisher examples: `mitre`, `circl`, `misp` @@ -41,3 +42,4 @@ A publisher can request one or more project to CyCAT associated to the publisher | `license` | License(s) of the project in SPX identifier (array) | :heavy_check_mark: | | `type` | [Taxonomy type](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | | `scope` | [Taxonomy scope](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | +| `timestamp` | Last update of the project record (unix timestamp)| :heavy_check_mark: | From ab91b1012285a16ecd8530b58fedef7dbe77c590 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Fri, 19 Feb 2021 09:29:18 +0100 Subject: [PATCH 4/7] Update concept.md --- _services/concept.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_services/concept.md b/_services/concept.md index 229d458..d466364 100644 --- a/_services/concept.md +++ b/_services/concept.md @@ -25,6 +25,7 @@ A publisher can be any organisation, project or individual requesting a publishe | `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | | `link` | Internet link referencing the publisher | :heavy_check_mark: | | `timestamp` | Last update of the publisher record (unix timestamp) | :heavy_check_mark: | +| `maintainer` | owner, external, cycat | - | Publisher examples: `mitre`, `circl`, `misp` @@ -43,3 +44,5 @@ A publisher can request one or more project to CyCAT associated to the publisher | `type` | [Taxonomy type](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | | `scope` | [Taxonomy scope](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | | `timestamp` | Last update of the project record (unix timestamp)| :heavy_check_mark: | +| `maintainer` | owner, external, cycat | - | + From 85b72456dfb6f072d8cf9d5f2527a065b23bc692 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Fri, 19 Feb 2021 09:44:32 +0100 Subject: [PATCH 5/7] Update concept.md --- _services/concept.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_services/concept.md b/_services/concept.md index d466364..718145e 100644 --- a/_services/concept.md +++ b/_services/concept.md @@ -13,7 +13,7 @@ by this publisher under a specific project. The CyCAT url is composed of two nam `publisher-short-name`:`project-short-name`:`UUID` -## Publisher +## Publisher namespace A publisher can be any organisation, project or individual requesting a publisher to CyCAT. @@ -22,14 +22,14 @@ A publisher can be any organisation, project or individual requesting a publishe | `name` | Name of the publisher (full name)| :heavy_check_mark: | | `short-name` | Name of the publisher (short name) | :heavy_check_mark: | | `description` | Description of the publisher | :heavy_check_mark: | -| `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | +| `cycat-oid` | assigned CyCAT OID | :heavy_check_mark: | | `link` | Internet link referencing the publisher | :heavy_check_mark: | | `timestamp` | Last update of the publisher record (unix timestamp) | :heavy_check_mark: | | `maintainer` | owner, external, cycat | - | Publisher examples: `mitre`, `circl`, `misp` -## Project +## Project namespace A publisher can request one or more project to CyCAT associated to the publisher namespace. @@ -38,7 +38,7 @@ A publisher can request one or more project to CyCAT associated to the publisher | `name` | Name of the project (full name)| :heavy_check_mark: | | `short-name` | Name of the project (short name) | :heavy_check_mark: | | `description` | Description of the project | :heavy_check_mark: | -| `cycat-uuid` | assigned CyCAT UUID | :heavy_check_mark: | +| `cycat-oid` | assigned CyCAT OID | :heavy_check_mark: | | `link` | Internet link referencing the project | :heavy_check_mark: | | `license` | License(s) of the project in SPX identifier (array) | :heavy_check_mark: | | `type` | [Taxonomy type](https://github.com/CyCat-project/cycat-taxonomy) of the project from CyCAT taxonomy | :heavy_check_mark: | From 0b0fa554fab5923312f2293521cf1e6862f3abe7 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Wed, 24 Feb 2021 08:08:24 +0100 Subject: [PATCH 6/7] chg: [concept] UUID definition + non-referenced URL generation --- _services/concept.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/_services/concept.md b/_services/concept.md index 718145e..78291c5 100644 --- a/_services/concept.md +++ b/_services/concept.md @@ -13,6 +13,12 @@ by this publisher under a specific project. The CyCAT url is composed of two nam `publisher-short-name`:`project-short-name`:`UUID` +## What is an UUID? + +A [universally unique identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier) is a 128-bit number used to identify information in computer systems also known as GUID. +CyCAT use such UUID to reference items produced in a collection. CyCAT, by default, will use any existing UUID already assigned by the publisher. If not present or there is no item present, +a fixed value is then calculated from the UUID namespace of CyCAT combined with `publisher-short-name:project-short-name`. + ## Publisher namespace A publisher can be any organisation, project or individual requesting a publisher to CyCAT. @@ -46,3 +52,13 @@ A publisher can request one or more project to CyCAT associated to the publisher | `timestamp` | Last update of the project record (unix timestamp)| :heavy_check_mark: | | `maintainer` | owner, external, cycat | - | +## URL example + +## How to generate a CyCAT url for non-registered url or missing item in a collection + +CyCAT has a fixed UUID namespace `690b3b43-d689-481c-aa61-5351963a36f2`. + +```shell +% uuidgen --sha1 -n "690b3b43-d689-481c-aa61-5351963a36f2" -N "samratashok:nishang:" +2605ff5e-342c-5326-8744-96a34b7e581e +``` From 6410f331f9d0ebd18d6a4320627a25c9d878aa44 Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Wed, 24 Feb 2021 08:10:21 +0100 Subject: [PATCH 7/7] chg: [jemoji] added --- Gemfile | 3 ++- _config.yml | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 02e01cb..cf65dc8 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,5 @@ source "https://rubygems.org" gem "jekyll", "~> 4.1" -gem "jekyll-environment-variables" \ No newline at end of file +gem "jekyll-environment-variables" +gem 'jemoji' diff --git a/_config.yml b/_config.yml index 353d565..b071efc 100755 --- a/_config.yml +++ b/_config.yml @@ -36,3 +36,4 @@ sass: plugins: - jekyll-environment-variables + - jemoji