From 59d2a301b9fbcb81a34e346c0d9f7961cb2a95ad Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Tue, 11 Jul 2023 16:54:11 +0200 Subject: [PATCH 1/6] new: add basic SigMF templates --- .../sigmf-expanded-recording/definition.json | 136 ++++++++++++++++++ objects/sigmf-recording/definition.json | 25 ++++ 2 files changed, 161 insertions(+) create mode 100644 objects/sigmf-expanded-recording/definition.json create mode 100644 objects/sigmf-recording/definition.json diff --git a/objects/sigmf-expanded-recording/definition.json b/objects/sigmf-expanded-recording/definition.json new file mode 100644 index 0000000..a9dbdae --- /dev/null +++ b/objects/sigmf-expanded-recording/definition.json @@ -0,0 +1,136 @@ +{ + "attributes": { + "iq-sample": { + "description": "Binary file of IQ samples", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 0 + }, + "datatype": { + "description": "", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "sample_rate": { + "description": "The sample rate of the signal in samples per second.", + "disable_correlation": true, + "misp-attribute": "float", + "ui-priority": 0 + }, + "version": { + "description": "The version of the SigMF specification used to create the Metadata file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "num_channels": { + "description": "Total number of interleaved channels in the Dataset file. If omitted, this defaults to one.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "sha512": { + "description": "The SHA512 hash of the Dataset file associated with the SigMF file.", + "disable_correlation": true, + "misp-attribute": "sha512", + "ui-priority": 0 + }, + "offset": { + "description": "The index number of the first sample in the Dataset. If not provided, this value defaults to zero. Typically used when a Recording is split over multiple files. All sample indices in SigMF are absolute, and so all other indices referenced in metadata for this recording SHOULD be greater than or equal to this value.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "description": { + "description": "A text description of the SigMF Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "author": { + "description": "A text identifier for the author potentially including name, handle, email, and/or other ID like Amateur Call Sign.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "meta_doi": { + "description": "The registered DOI (ISO 26324) for a Recording's Metadata file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "data_doi": { + "description": "The registered DOI (ISO 26324) for a Recording's Dataset file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "recorder": { + "description": "The name of the software used to make this SigMF Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "license": { + "description": "A URL for the license document under which the Recording is offered.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "hw": { + "description": "A text description of the hardware used to make the Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "dataset": { + "description": "The full filename of the Dataset file this Metadata file describes.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "trailing_bytes": { + "description": "The number of bytes to ignore at the end of a Non-Conforming Dataset file.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "metadata_only": { + "description": "Indicates the Metadata file is intentionally distributed without the Dataset.", + "disable_correlation": true, + "misp-attribute": "boolean", + "ui-priority": 0 + }, + "geolocation_lat": { + "description": "The location of the Recording system (latitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "geolocation_long": { + "description": "The location of the Recording system (longitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "geolocation_alt": { + "description": "The location of the Recording system (altitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "collection": { + "description": "The base filename of a collection with which this Recording is associated.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + } + }, + "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-expanded-recording", + "uuid": "f1c2c4e1-d3bf-46b1-b34d-f5e9544a4795", + "version": 1 +} \ No newline at end of file diff --git a/objects/sigmf-recording/definition.json b/objects/sigmf-recording/definition.json new file mode 100644 index 0000000..afe313e --- /dev/null +++ b/objects/sigmf-recording/definition.json @@ -0,0 +1,25 @@ +{ + "attributes": { + "SigMF-meta": { + "description": "Metadata file in SigMF format (.sigmf-meta)", + "disable_correlation": true, + "misp-attribute": "attachment", + "ui-priority": 0 + }, + "SigMF-data": { + "description": "Binary file of IQ or RF samples (.sigmf-data)", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 1 + } + }, + "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-recording", + "required": [ + "SigMF-meta" + ], + "uuid": "0ca64648-38ca-4e48-99ce-2e655cdac02c", + "version": 1 +} \ No newline at end of file From ba6bad723b1b124ed65aaca166a1a26fb01de6fa Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Tue, 11 Jul 2023 17:04:18 +0200 Subject: [PATCH 2/6] fix: jq all the things --- .../sigmf-expanded-recording/definition.json | 266 +++++++++--------- objects/sigmf-recording/definition.json | 44 +-- 2 files changed, 155 insertions(+), 155 deletions(-) diff --git a/objects/sigmf-expanded-recording/definition.json b/objects/sigmf-expanded-recording/definition.json index a9dbdae..ae50d7c 100644 --- a/objects/sigmf-expanded-recording/definition.json +++ b/objects/sigmf-expanded-recording/definition.json @@ -1,136 +1,136 @@ { - "attributes": { - "iq-sample": { - "description": "Binary file of IQ samples", - "disable_correlation": true, - "misp-attribute": "attachment", - "multiple": true, - "ui-priority": 0 - }, - "datatype": { - "description": "", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "sample_rate": { - "description": "The sample rate of the signal in samples per second.", - "disable_correlation": true, - "misp-attribute": "float", - "ui-priority": 0 - }, - "version": { - "description": "The version of the SigMF specification used to create the Metadata file.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "num_channels": { - "description": "Total number of interleaved channels in the Dataset file. If omitted, this defaults to one.", - "disable_correlation": true, - "misp-attribute": "counter", - "ui-priority": 0 - }, - "sha512": { - "description": "The SHA512 hash of the Dataset file associated with the SigMF file.", - "disable_correlation": true, - "misp-attribute": "sha512", - "ui-priority": 0 - }, - "offset": { - "description": "The index number of the first sample in the Dataset. If not provided, this value defaults to zero. Typically used when a Recording is split over multiple files. All sample indices in SigMF are absolute, and so all other indices referenced in metadata for this recording SHOULD be greater than or equal to this value.", - "disable_correlation": true, - "misp-attribute": "counter", - "ui-priority": 0 - }, - "description": { - "description": "A text description of the SigMF Recording.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "author": { - "description": "A text identifier for the author potentially including name, handle, email, and/or other ID like Amateur Call Sign.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "meta_doi": { - "description": "The registered DOI (ISO 26324) for a Recording's Metadata file.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "data_doi": { - "description": "The registered DOI (ISO 26324) for a Recording's Dataset file.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "recorder": { - "description": "The name of the software used to make this SigMF Recording.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "license": { - "description": "A URL for the license document under which the Recording is offered.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "hw": { - "description": "A text description of the hardware used to make the Recording.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "dataset": { - "description": "The full filename of the Dataset file this Metadata file describes.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "trailing_bytes": { - "description": "The number of bytes to ignore at the end of a Non-Conforming Dataset file.", - "disable_correlation": true, - "misp-attribute": "counter", - "ui-priority": 0 - }, - "metadata_only": { - "description": "Indicates the Metadata file is intentionally distributed without the Dataset.", - "disable_correlation": true, - "misp-attribute": "boolean", - "ui-priority": 0 - }, - "geolocation_lat": { - "description": "The location of the Recording system (latitude).", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "geolocation_long": { - "description": "The location of the Recording system (longitude).", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "geolocation_alt": { - "description": "The location of the Recording system (altitude).", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - }, - "collection": { - "description": "The base filename of a collection with which this Recording is associated.", - "disable_correlation": true, - "misp-attribute": "text", - "ui-priority": 0 - } + "attributes": { + "author": { + "description": "A text identifier for the author potentially including name, handle, email, and/or other ID like Amateur Call Sign.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 }, - "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", - "meta-category": "misc", - "name": "sigmf-expanded-recording", - "uuid": "f1c2c4e1-d3bf-46b1-b34d-f5e9544a4795", - "version": 1 + "collection": { + "description": "The base filename of a collection with which this Recording is associated.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "data_doi": { + "description": "The registered DOI (ISO 26324) for a Recording's Dataset file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "dataset": { + "description": "The full filename of the Dataset file this Metadata file describes.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "datatype": { + "description": "", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "description": { + "description": "A text description of the SigMF Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "geolocation_alt": { + "description": "The location of the Recording system (altitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "geolocation_lat": { + "description": "The location of the Recording system (latitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "geolocation_long": { + "description": "The location of the Recording system (longitude).", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "hw": { + "description": "A text description of the hardware used to make the Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "iq-sample": { + "description": "Binary file of IQ samples", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 0 + }, + "license": { + "description": "A URL for the license document under which the Recording is offered.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "meta_doi": { + "description": "The registered DOI (ISO 26324) for a Recording's Metadata file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "metadata_only": { + "description": "Indicates the Metadata file is intentionally distributed without the Dataset.", + "disable_correlation": true, + "misp-attribute": "boolean", + "ui-priority": 0 + }, + "num_channels": { + "description": "Total number of interleaved channels in the Dataset file. If omitted, this defaults to one.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "offset": { + "description": "The index number of the first sample in the Dataset. If not provided, this value defaults to zero. Typically used when a Recording is split over multiple files. All sample indices in SigMF are absolute, and so all other indices referenced in metadata for this recording SHOULD be greater than or equal to this value.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "recorder": { + "description": "The name of the software used to make this SigMF Recording.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + }, + "sample_rate": { + "description": "The sample rate of the signal in samples per second.", + "disable_correlation": true, + "misp-attribute": "float", + "ui-priority": 0 + }, + "sha512": { + "description": "The SHA512 hash of the Dataset file associated with the SigMF file.", + "disable_correlation": true, + "misp-attribute": "sha512", + "ui-priority": 0 + }, + "trailing_bytes": { + "description": "The number of bytes to ignore at the end of a Non-Conforming Dataset file.", + "disable_correlation": true, + "misp-attribute": "counter", + "ui-priority": 0 + }, + "version": { + "description": "The version of the SigMF specification used to create the Metadata file.", + "disable_correlation": true, + "misp-attribute": "text", + "ui-priority": 0 + } + }, + "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-expanded-recording", + "uuid": "f1c2c4e1-d3bf-46b1-b34d-f5e9544a4795", + "version": 1 } \ No newline at end of file diff --git a/objects/sigmf-recording/definition.json b/objects/sigmf-recording/definition.json index afe313e..af68a0b 100644 --- a/objects/sigmf-recording/definition.json +++ b/objects/sigmf-recording/definition.json @@ -1,25 +1,25 @@ { - "attributes": { - "SigMF-meta": { - "description": "Metadata file in SigMF format (.sigmf-meta)", - "disable_correlation": true, - "misp-attribute": "attachment", - "ui-priority": 0 - }, - "SigMF-data": { - "description": "Binary file of IQ or RF samples (.sigmf-data)", - "disable_correlation": true, - "misp-attribute": "attachment", - "multiple": true, - "ui-priority": 1 - } + "attributes": { + "SigMF-data": { + "description": "Binary file of IQ or RF samples (.sigmf-data)", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 1 }, - "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", - "meta-category": "misc", - "name": "sigmf-recording", - "required": [ - "SigMF-meta" - ], - "uuid": "0ca64648-38ca-4e48-99ce-2e655cdac02c", - "version": 1 + "SigMF-meta": { + "description": "Metadata file in SigMF format (.sigmf-meta)", + "disable_correlation": true, + "misp-attribute": "attachment", + "ui-priority": 0 + } + }, + "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-recording", + "required": [ + "SigMF-meta" + ], + "uuid": "0ca64648-38ca-4e48-99ce-2e655cdac02c", + "version": 1 } \ No newline at end of file From 316a4b07d1ba49be3c52043f7e59e4f0c7d89152 Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Wed, 12 Jul 2023 15:33:23 +0200 Subject: [PATCH 3/6] new: add fft and waterfall attributes --- objects/sigmf-expanded-recording/definition.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/objects/sigmf-expanded-recording/definition.json b/objects/sigmf-expanded-recording/definition.json index ae50d7c..d852864 100644 --- a/objects/sigmf-expanded-recording/definition.json +++ b/objects/sigmf-expanded-recording/definition.json @@ -36,6 +36,13 @@ "misp-attribute": "text", "ui-priority": 0 }, + "fft-plot": { + "description": "FFT plot of the signal", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 0 + }, "geolocation_alt": { "description": "The location of the Recording system (altitude).", "disable_correlation": true, @@ -126,6 +133,13 @@ "disable_correlation": true, "misp-attribute": "text", "ui-priority": 0 + }, + "waterfall-plot": { + "description": "Waterfall plot of the signal", + "disable_correlation": true, + "misp-attribute": "attachment", + "multiple": true, + "ui-priority": 0 } }, "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", From ac201f475ae90ff929c3c51843006336e8983303 Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Thu, 3 Aug 2023 08:07:33 +0200 Subject: [PATCH 4/6] new: sigmf archive object --- objects/sigmf-archive/definition.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 objects/sigmf-archive/definition.json diff --git a/objects/sigmf-archive/definition.json b/objects/sigmf-archive/definition.json new file mode 100644 index 0000000..b846ba5 --- /dev/null +++ b/objects/sigmf-archive/definition.json @@ -0,0 +1,18 @@ +{ + "attributes": { + "SigMF-archive": { + "description": "tar archive (.sigmf)", + "disable_correlation": true, + "misp-attribute": "attachment", + "ui-priority": 1 + } + }, + "description": "An object representing an archive containing one or multiple recordings in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-archive", + "required": [ + "SigMF-archive" + ], + "uuid": "5985d34d-3657-4828-9788-470175bcc3b1", + "version": 1 + } \ No newline at end of file From 17a68d93aefe0eb13c54ce5d7f95046aea5650e3 Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Thu, 3 Aug 2023 08:07:47 +0200 Subject: [PATCH 5/6] fix: minor fixes --- objects/sigmf-expanded-recording/definition.json | 3 --- objects/sigmf-recording/definition.json | 3 +-- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/objects/sigmf-expanded-recording/definition.json b/objects/sigmf-expanded-recording/definition.json index d852864..e4254e5 100644 --- a/objects/sigmf-expanded-recording/definition.json +++ b/objects/sigmf-expanded-recording/definition.json @@ -40,7 +40,6 @@ "description": "FFT plot of the signal", "disable_correlation": true, "misp-attribute": "attachment", - "multiple": true, "ui-priority": 0 }, "geolocation_alt": { @@ -71,7 +70,6 @@ "description": "Binary file of IQ samples", "disable_correlation": true, "misp-attribute": "attachment", - "multiple": true, "ui-priority": 0 }, "license": { @@ -138,7 +136,6 @@ "description": "Waterfall plot of the signal", "disable_correlation": true, "misp-attribute": "attachment", - "multiple": true, "ui-priority": 0 } }, diff --git a/objects/sigmf-recording/definition.json b/objects/sigmf-recording/definition.json index af68a0b..1bc98d8 100644 --- a/objects/sigmf-recording/definition.json +++ b/objects/sigmf-recording/definition.json @@ -4,7 +4,6 @@ "description": "Binary file of IQ or RF samples (.sigmf-data)", "disable_correlation": true, "misp-attribute": "attachment", - "multiple": true, "ui-priority": 1 }, "SigMF-meta": { @@ -14,7 +13,7 @@ "ui-priority": 0 } }, - "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", + "description": "An object representing a single IQ/RF sample in the Signal Metadata Format Specification (SigMF)", "meta-category": "misc", "name": "sigmf-recording", "required": [ From 21b06c2f48dc091381bb813160fa257718f0cc51 Mon Sep 17 00:00:00 2001 From: Luciano Righetti Date: Thu, 3 Aug 2023 09:30:58 +0200 Subject: [PATCH 6/6] fix: jq all the things --- objects/sigmf-archive/definition.json | 34 +++++++++++++-------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/objects/sigmf-archive/definition.json b/objects/sigmf-archive/definition.json index b846ba5..d5c3d3e 100644 --- a/objects/sigmf-archive/definition.json +++ b/objects/sigmf-archive/definition.json @@ -1,18 +1,18 @@ { - "attributes": { - "SigMF-archive": { - "description": "tar archive (.sigmf)", - "disable_correlation": true, - "misp-attribute": "attachment", - "ui-priority": 1 - } - }, - "description": "An object representing an archive containing one or multiple recordings in the Signal Metadata Format Specification (SigMF)", - "meta-category": "misc", - "name": "sigmf-archive", - "required": [ - "SigMF-archive" - ], - "uuid": "5985d34d-3657-4828-9788-470175bcc3b1", - "version": 1 - } \ No newline at end of file + "attributes": { + "SigMF-archive": { + "description": "tar archive (.sigmf)", + "disable_correlation": true, + "misp-attribute": "attachment", + "ui-priority": 1 + } + }, + "description": "An object representing an archive containing one or multiple recordings in the Signal Metadata Format Specification (SigMF)", + "meta-category": "misc", + "name": "sigmf-archive", + "required": [ + "SigMF-archive" + ], + "uuid": "5985d34d-3657-4828-9788-470175bcc3b1", + "version": 1 +} \ No newline at end of file