Skip to content

suit-wg/suit-report

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

107 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SUIT-Report

Secure status reporting for SUIT manifests

Converting draft from md file

Prerequisite packages

Requires two packages:

kramdown-rfc2629 by Ruby
xml2rfc by Python

Installing required packages on Fedora

sudo dnf makecache
sudo dnf -y install python3-pip git make gem
pip3 install xml2rfc
gem install kramdown-rfc2629 cddl cddlc

Installing required packages on Ubuntu

sudo apt-get update
sudo apt-get -y install python3-pip ruby git curl
pip3 install xml2rfc
gem install kramdown-rfc2629 cddl cddlc

Generating draft from a markdown file

git clone https://github.com/suit-wg/suit-report.git
cd suit-report
make

It will create draft-ietf-suit-report.txt, draft-ietf-suit-report.xml and draft-ietf-suit-report.html

Conduct CDDL syntax check

To check the cddl syntax whenever making changes in the cddl file

make -C cddl clean
make -C cddl
make -C cddl cddl-syntax-check

Updating repo on GitHub

Make updates to the draft-ietf-suit-report.md and/or draft-ietf-suit-report.cddl. Regenerate xml, txt and html with make command.

Commit and push to GitHub the changes on all files listed below.

draft-ietf-suit-report.md
draft-ietf-suit-report.cddl

Submitting draft

Generate xml file containing version number only when submitting draft since the datatracker require the version number on both inside the xml and on the file name

Instead of hard coding the version number in the md file, this way will make it easier to regularly update the md and cddl file in the repo on the github by keeping the file name consistent. Otherwise, it will require manually changing the file names back to the without version number every time when git commit and push.

Revise the next line in the file ‘draft-ietf-suit-report.md’

docname: draft-ietf-suit-report

with adding the version number at the end for submitting the draft. For example, If the current draft version is ‘08’ then change it as the line below.

docname: draft-ietf-suit-report-09

Generate the xml file with make command. This will generate the draft-ietf-suit-report-09.xml for the example above. Upload the new xml file as the draft to the datatracker at ietf.

Link to submit the revised draft. https://datatracker.ietf.org/submit/

About

Secure status reporting for SUIT manifests

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Makefile 74.5%
  • Python 25.5%