cycat-project-website/_services/concept.md

3.1 KiB

title date featured weight layout
CyCAT - Core Concept 2021-02-19T01:33:46+10:00 true 1 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

What is an UUID?

A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems also known as GUID. CyCAT uses 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.

Field name Description Required
name Name of the publisher (full name) ✔️
short-name Name of the publisher (short name) ✔️
description Description of the publisher ✔️
cycat-oid assigned CyCAT OID ✔️
link Internet link referencing the publisher ✔️
timestamp Last update of the publisher record (unix timestamp) ✔️
maintainer owner, external, cycat -

Publisher examples: mitre, circl, misp

Project namespace

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) ✔️
short-name Name of the project (short name) ✔️
description Description of the project ✔️
cycat-oid assigned CyCAT OID ✔️
link Internet link referencing the project ✔️
license License(s) of the project in SPX identifier (array) ✔️
type Taxonomy type of the project from CyCAT taxonomy ✔️
scope Taxonomy scope of the project from CyCAT taxonomy ✔️
timestamp Last update of the project record (unix timestamp) ✔️
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.

% uuidgen --sha1 -n "690b3b43-d689-481c-aa61-5351963a36f2" -N "samratashok:nishang:"
2605ff5e-342c-5326-8744-96a34b7e581e