Something went wrong. Try again.
JavaScript generic ASN.1 parser (mirror)
Something went wrong. Try again.
asn1js parseRFC.js
22 kB · 588 lines
JavaScript
at github-101
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589#! /usr/bin/env node
// RFC ASN.1 definition parser// Copyright (c) 2021 Lapo Luchini <lapo@lapo.it>
// Permission to use, copy, modify, and/or distribute this software for any// purpose with or without fee is hereby granted, provided that the above// copyright notice and this permission notice appear in all copies.//// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
import * as fs from 'node:fs';
const patches = { // to fix some known RFCs' ASN.1 syntax errors 0: [ [ /\n\n[A-Z].*\n\f\n[A-Z].*\n\n/g, '' ], // page change ], 2459: [ // currently unsupported [ 'videotex (8) } (0..ub-integer-options)', 'videotex (8) }' ], [ /OBJECT IDENTIFIER \( id-qt-cps \| id-qt-unotice \)/g, 'OBJECT IDENTIFIER' ], [ /SIGNED \{ (SEQUENCE \{[^}]+\})\s*\}/g, 'SEQUENCE { toBeSigned $1, algorithm AlgorithmIdentifier, signature BIT STRING }' ], [ /EXTENSION\.&[^,]+/g, 'OBJECT IDENTIFIER'], ], 2986: [ // currently unsupported [ /FROM (InformationFramework|AuthenticationFramework) [a-zA-Z]+/g, 'FROM $1 {joint-iso-itu-t(2) ds(5) module(1) usefulDefinitions(0) 3}' ], [ /[(]v1,[^)]+[)]/g, '' ], [ /[{][{][^}]+[}][}]/g, '' ], [ 'SubjectPublicKeyInfo {ALGORITHM: IOSet}', 'SubjectPublicKeyInfo' ], [ /PKInfoAlgorithms ALGORITHM ::=[^}]+[}]/g, '' ], [ /(Attributes?) [{] ATTRIBUTE:IOSet [}]/g, '$1' ], [ /CRIAttributes +ATTRIBUTE +::=[^}]+[}]/g, '' ], [ /[A-Z]+[.]&id[(][{]IOSet[}][)]/g, 'OBJECT IDENTIFIER' ], [ /[A-Z]+[.]&Type[(][{]IOSet[}][{]@[a-z]+[}][)]/g, 'ANY' ], [ /(AlgorithmIdentifier) [{]ALGORITHM:IOSet [}]/g, '$1' ], [ /SignatureAlgorithms ALGORITHM ::=[^}]+[}]/g, '' ], ], 3161: [ // actual syntax errors [ /--.*}/g, '}' ], [ /^( +)--.*\n(?:\1 .*\n)+/mg, '' ], [ /addInfoNotAvailable \(17\)/g, '$&,' ], ], 5208: [ // currently unsupported [ 'FROM InformationFramework informationFramework', 'FROM InformationFramework {joint-iso-itu-t(2) ds(5) module(1) usefulDefinitions(0) 3}' ], [ ' {{PrivateKeyAlgorithms}}', '' ], [ 'Version ::= INTEGER {v1(0)} (v1,...)', 'Version ::= INTEGER {v1(0)}' ], [ ' {{KeyEncryptionAlgorithms}}', '' ], [ /\.\.\. -- For local profiles/g, '' ], ], 5280: [ // currently unsupported [ 'videotex (8) } (0..ub-integer-options)', 'videotex (8) }' ], [ /OBJECT IDENTIFIER \( id-qt-cps \| id-qt-unotice \)/g, 'OBJECT IDENTIFIER' ], ], 4210: [ [ /^\s+-- .*\r?\n/mg, '' ], // comments ], 8017: [ // this RFC uses a lot of currently unsupported syntax [ /ALGORITHM-IDENTIFIER ::= CLASS[^-]+--/, '--' ], [ /\n +\S+ +ALGORITHM-IDENTIFIER[^\n]+(\n {6}[^\n]+)+\n {3}[}]/g, '' ], [ /AlgorithmIdentifier [{] ALGORITHM-IDENTIFIER:InfoObjectSet [}] ::=(\n {6}[^\n]+)+\n {3}[}]/, 'AlgorithmIdentifier ::= ANY'], [ /algorithm +id-[^,\n]+,/g, 'algorithm ANY,' ], [ / (sha1 {4}HashAlgorithm|mgf1SHA1 {4}MaskGenAlgorithm|pSpecifiedEmpty {4}PSourceAlgorithm|rSAES-OAEP-Default-Identifier {4}RSAES-AlgorithmIdentifier|rSASSA-PSS-Default-Identifier {4}RSASSA-AlgorithmIdentifier) ::= [{](\n( {6}[^\n]+)?)+\n {3}[}]/g, '' ], [ / ::= AlgorithmIdentifier [{]\s+[{][^}]+[}]\s+[}]/g, ' ::= AlgorithmIdentifier' ], [ /OCTET STRING[(]SIZE[(]0..MAX[)][)]/g, 'OCTET STRING' ], [ /emptyString {4}EncodingParameters ::= ''H/g, '' ], [ /[(]CONSTRAINED BY[^)]+[)]/g, '' ], ], 4511: [ [ /^\s+-- .*\r?\n/mg, '' ], // comments [ 'EXTENSIBILITY IMPLIED', '' ], [ /\.\.\.(,| {2})/g, '' ], [ /value AttributeValue/g, 'AttributeValue' ], [ /control Control/g, 'Control' ], [ /Attribute ::= PartialAttribute\(WITH COMPONENTS \{[^}]+\}\)/g, 'PartialAttribute ::= SEQUENCE { type AttributeDescription, vals SET SIZE (1..MAX) OF AttributeValue }' ], [ /,\s+\}/g, '}' ], [ /SaslCredentials,/g, 'SaslCredentials' ], [ /(BindResponse|ExtendedResponse) ::= \[APPLICATION [0-9]+\] SEQUENCE \{[^}]+\}/g, '$1 ::= ANY' ], [ /selector LDAPString/g, 'LDAPString' ], [ /filter Filter/g, 'Filter' ], [ /MatchingRuleAssertion,/g, 'MatchingRuleAssertion' ], [ /OF substring CHOICE/g, 'OF CHOICE' ], [ /partialAttribute PartialAttribute/g, 'PartialAttribute' ], [ /uri URI/g, 'URI' ], [ /OF change SEQUENCE/g, 'OF SEQUENCE' ], [ /attribute Attribute/g, 'Attribute' ], ], };
// const reWhitespace = /(?:\s|--(?:[}-]?[^\n}-])*(?:\n|--))*/y;const reWhitespace = /(?:\s|--(?:-?[^\n-])*(?:\n|--))*/my;const reIdentifier = /[a-zA-Z](?:[-]?[a-zA-Z0-9])*/y;const reNumber = /0|[1-9][0-9]*/y;const reToken = /[(){},[\];]|::=|OPTIONAL|DEFAULT|NULL|TRUE|FALSE|\.\.|OF|SIZE|MIN|MAX|DEFINED BY|DEFINITIONS|TAGS|BEGIN|EXPORTS|IMPORTS|FROM|END/y;const reType = /ANY|NULL|BOOLEAN|INTEGER|(?:BIT|OCTET)\s+STRING|OBJECT\s+IDENTIFIER|SEQUENCE|SET|CHOICE|ENUMERATED|(?:Generalized|UTC)Time|(?:BMP|General|Graphic|IA5|ISO64|Numeric|Printable|Teletex|T61|Universal|UTF8|Videotex|Visible)String/y;const reTagClass = /UNIVERSAL|APPLICATION|PRIVATE|/y;const reTagType = /IMPLICIT|EXPLICIT|/y;const reTagDefault = /(AUTOMATIC|IMPLICIT|EXPLICIT) TAGS|/y;
let asn1;let currentMod;
function searchImportedValue(id) { for (let imp of Object.values(currentMod.imports)) for (let name of imp.types) if (name == id) { if (!(imp.oid in asn1)) throw new Error('Cannot find module: ' + imp.oid + ' ' + id); if (id in asn1[imp.oid].values) return asn1[imp.oid].values[id]; throw new Error('Cannot find imported value: ' + imp.oid + ' ' + id); } throw new Error('Cannot find imported value in any module: ' + id);}
class Parser { constructor(enc, pos) { this.enc = enc; this.pos = pos; this.start = pos; } getChar(pos) { if (pos === undefined) pos = this.pos++; if (pos >= this.enc.length) throw 'Requesting byte offset ' + pos + ' on a stream of length ' + this.enc.length; return this.enc.charAt(pos); } exception(s) { const pos = this.pos; let from = Math.max(pos - 30, this.start); let to = Math.min(pos + 30, this.enc.length); let ctx = ''; let arrow = ''; let i = from; for (; i < pos; ++i) { ctx += this.getChar(i); arrow += ' '; } ctx += this.getChar(i++); arrow += '^'; for (; i < to; ++i) ctx += this.getChar(i); // calculate line/column let line = 1; let lastLF = 0; for (let i = 0; i < pos; ++i) if (this.enc.charAt(i) == '\n') { ++line; lastLF = i; } let column = pos - lastLF; throw new Error('[position ' + pos + ', line ' + line + ':' + column + '] ' + s + '\n' + ctx.replace(/\s/g, ' ') + '\n' + arrow); } peek() { return this.enc.charCodeAt(this.pos); } peekChar() { return this.enc.charAt(this.pos); } isWhitespace() { let c = this.peekChar(); return c == ' ' || c == '\n'; } isDigit() { let c = this.peekChar(); return c >= '0' && c <= '9'; } skipWhitespace() { reWhitespace.lastIndex = this.pos; let s = reWhitespace.exec(this.enc); if (s) this.pos = reWhitespace.lastIndex; } // DefStream.prototype.eat = function (str) { // for (let i = 0; i < str.length; ++i) { // let c = this.getChar(); // if (c != str.charAt(i)) // throw new Error("Found '" + c + "', was expecting '" + str.charAt(i) + "'"); // } // }; getRegEx(type, re) { this.skipWhitespace(); re.lastIndex = this.pos; let s = re.exec(this.enc); //TODO: does not work with typed arrays if (!s) this.exception("Found '" + this.peekChar() + "', was expecting a " + type); s = s[0]; // console.log('[debug] getRexEx@' + this.pos + ' = ' + s); this.pos = re.lastIndex; this.skipWhitespace(); return s; } parseIdentifier() { let id = this.getRegEx('identifier', reIdentifier); // console.log('[debug] parseIdentifier = ' + id); return id; } parseNumber() { let id = this.getRegEx('number', reNumber); // console.log('[debug] parseNumber = ' + id); return id; } parseToken() { let tok = this.getRegEx('token', reToken); return tok; } tryToken(expect) { let p = this.pos; let t; try { t = this.parseToken(); } catch (e) { /*ignore*/ } // console.log('[debug] tryToken(' + expect + ') = ' + t); if (t == expect) return true; else { this.pos = p; return false; } } expectToken(expect) { let p = this.pos; let t; try { t = this.parseToken(); } catch (e) { console.log('[debug] expectToken', e); } // console.log('[debug] expectToken(' + expect + ') = ' + t); if (t != expect) { this.pos = p; this.exception("Found '" + t + "', was expecting '" + expect + "'"); } } parseNumberOrValue() { if (this.isDigit()) return +this.parseNumber(); return this.parseIdentifier(); } parseRange() { let min = this.tryToken('MIN') ? 'MIN' : this.parseNumberOrValue(); if (this.tryToken('..')) { let max = this.tryToken('MAX') ? 'MAX' : this.parseNumberOrValue(); return [min, max]; } return min; } parseBuiltinType() { let x = { name: this.getRegEx('type', reType), type: 'builtin', }; // console.log('[debug] parseType = ' + x.name); try { switch (x.name) { case 'ANY': if (this.tryToken('DEFINED BY')) x.definedBy = this.parseIdentifier(); break; case 'NULL': case 'BOOLEAN': case 'OCTET STRING': case 'OBJECT IDENTIFIER': break; case 'CHOICE': x.content = this.parseElementTypeList(); break; case 'SEQUENCE': case 'SET': if (this.peekChar() == '{') { x.content = this.parseElementTypeList(); } else { x.typeOf = 1; if (this.tryToken('SIZE')) { this.expectToken('('); x.size = this.parseRange(); this.expectToken(')'); } this.expectToken('OF'); x.content = [this.parseType()]; } break; case 'INTEGER': if (this.tryToken('(')) { x.range = this.parseRange(); this.expectToken(')'); } // falls through case 'ENUMERATED': case 'BIT STRING': if (this.tryToken('{')) { x.content = {}; do { let id = this.parseIdentifier(); this.expectToken('('); let val = this.parseNumber(); //TODO: signed this.expectToken(')'); x.content[id] = +val; } while (this.tryToken(',')); this.expectToken('}'); } break; case 'BMPString': case 'GeneralString': case 'GraphicString': case 'IA5String': case 'ISO646String': case 'NumericString': case 'PrintableString': case 'TeletexString': case 'T61String': case 'UniversalString': case 'UTF8String': case 'VideotexString': case 'VisibleString': if (this.tryToken('(')) { if (this.tryToken('SIZE')) { this.expectToken('('); x.size = this.parseRange(); this.expectToken(')'); } this.expectToken(')'); } break; case 'UTCTime': case 'GeneralizedTime': break; default: x.warning = 'type unknown'; } } catch (e) { console.log('[debug] parseBuiltinType content', e); x.warning = 'type exception'; } return x; } parseTaggedType() { this.expectToken('['); let tagClass = this.getRegEx('class', reTagClass) || 'CONTEXT'; //TODO: use module defaults let t = this.parseNumber(); this.expectToken(']'); let plicit = this.getRegEx('explicit/implicit', reTagType); if (plicit == '') plicit = currentMod.tagDefault; let x = this.parseType(); let name; switch (tagClass) { // keep in sync with ASN1.typeName case 'APPLICATION': name = 'Application ' + t; break; case 'PRIVATE': name = 'Private ' + t; break; case 'CONTEXT': // fall through default: name = '[' + t + ']'; break; } return { name, type: 'tag', 'class': tagClass, explicit: (plicit == 'EXPLICIT'), content: [{ name: '', type: x }], }; } parseType() { if (this.peekChar() == '[') return this.parseTaggedType(); let p = this.pos; try { return this.parseBuiltinType(); } catch (e) { // console.log('[debug] parseAssignment failed on parseType', e); this.pos = p; let x = { name: this.parseIdentifier(), type: 'defined', }; // let from = searchImportedType(x.name); // if (from) // x.module = from; return x; //TODO "restricted string type" } } parseValueBoolean() { let p = this.pos; let t = this.parseToken(); if (t == 'TRUE') return true; if (t == 'FALSE') return false; this.pos = p; this.exception("Found '" + t + "', was expecting a boolean"); } parseValueOID() { this.expectToken('{'); let v = ''; while (!this.tryToken('}')) { let p = this.pos; let val; if (this.isDigit()) val = this.parseNumber(); else { this.pos = p; let id = this.parseIdentifier(); if (this.tryToken('(')) { val = this.parseNumber(); this.expectToken(')'); } else { if (id in currentMod.values) // defined in local module val = currentMod.values[id].value; else try { val = searchImportedValue(id); } catch (e) { this.exception(e.message); } } } if (v.length) v += '.'; v += val; } return v; } parseValue() { let c = this.peekChar(); if (c == '{') return this.parseValueOID(); if (c >= '0' && c <= '9') return +this.parseNumber(); if (c == '-') return -this.parseNumber(); let p = this.pos; try { switch (this.parseToken()) { case 'TRUE': return true; case 'FALSE': return false; case 'NULL': return null; } } catch (e) { this.pos = p; } p = this.pos; try { return this.parseIdentifier(); } catch (e) { this.pos = p; } this.exception('Unknown value type.'); } /*DefStream.prototype.parseValue = function (type) { console.log('[debug] parseValue type:', type); if (type.type == 'defined') { if (!(type.name in types)) this.exception("Missing type: " + type.name); type = types[type.name]; } switch (type.name) { case 'BOOLEAN': return this.parseValueBoolean(); case 'OBJECT IDENTIFIER': return this.parseValueOID(); default: console.log('[debug] parseValue unknown:', type); return 'TODO:value'; } }*/ parseElementType() { let x = Object.assign({ id: this.parseIdentifier() }, this.parseType()); // console.log('[debug] parseElementType 1:', x); if (this.tryToken('OPTIONAL')) x.optional = true; if (this.tryToken('DEFAULT')) x.default = this.parseValue(x.type); // console.log('[debug] parseElementType 2:', x); return x; } parseElementTypeList() { let v = []; this.expectToken('{'); do { v.push(this.parseElementType()); } while (this.tryToken(',')); this.expectToken('}'); return v; } parseAssignment() { let name = this.parseIdentifier(); if (this.tryToken('::=')) { // type assignment // console.log('type name', name); let type = this.parseType(); currentMod.types[name] = { name, type }; return currentMod.types[name]; } else { // value assignment // console.log('value name', name); let type = this.parseType(); // console.log('[debug] parseAssignment type:', type); this.expectToken('::='); let value = this.parseValue(type); currentMod.values[name] = { name, type, value }; return currentMod.values[name]; } } parseModuleIdentifier() { return { name: this.parseIdentifier(), oid: this.parseValueOID(), }; } parseSymbolsImported() { let imports = {}; do { let l = []; do { l.push(this.parseIdentifier()); } while (this.tryToken(',')); this.expectToken('FROM'); let mod = this.parseModuleIdentifier(); mod.types = l; imports[mod.oid] = mod; } while (this.peekChar() != ';'); return imports; } parseModuleDefinition(file) { let mod = this.parseModuleIdentifier(); currentMod = mod; // for deeply nested parsers mod.source = file; this.expectToken('DEFINITIONS'); mod.tagDefault = this.getRegEx('tag default', reTagDefault).split(' ')[0]; this.expectToken('::='); this.expectToken('BEGIN'); //TODO this.tryToken('EXPORTS') if (this.tryToken('IMPORTS')) { mod.imports = this.parseSymbolsImported(); this.expectToken(';'); } mod.values = {}; mod.types = {}; while (!this.tryToken('END')) this.parseAssignment(); return mod; }}
let s = fs.readFileSync(process.argv[2], 'utf8');let num = /^Request for Comments: ([0-9]+)/m.exec(s)[1];console.log('RFC:', num);for (let p of patches[0]) s = s.replace(p[0], p[1]);if (num in patches) for (let p of patches[num]) s = s.replace(p[0], p[1]);fs.writeFileSync(process.argv[2].replace(/[.]txt$/, '_patched.txt'), s, 'utf8');// console.log(s);asn1 = JSON.parse(fs.readFileSync(process.argv[3], 'utf8'));const reModuleDefinition = /\s[A-Z](?:[-]?[a-zA-Z0-9])*\s*\{[^}]+\}\s*(^--.*|\n)*DEFINITIONS/gm;let m;while ((m = reModuleDefinition.exec(s))) { new Parser(s, m.index).parseModuleDefinition(process.argv[2]); console.log('Module:', currentMod.name); // fs.writeFileSync('rfc' + num + '.json', JSON.stringify(currentMod, null, 2) + '\n', 'utf8'); asn1[currentMod.oid] = currentMod;}/*asn1 = Object.keys(asn1).sort().reduce( (obj, key) => { obj[key] = asn1[key]; return obj; }, {});*/fs.writeFileSync(process.argv[3], JSON.stringify(asn1, null, 2) + '\n', 'utf8');// console.log('Module:', mod);/*while ((idx = s.indexOf('::=', idx + 1)) >= 0) { let line = s.lastIndexOf('\n', idx) + 1; // console.log('[line] ' + s.slice(line, line+30)); try { let a = new DefStream(s, line).parseAssignment(); // console.log('[assignment]', util.inspect(a, {showHidden: false, depth: null, colors: true})); } catch (e) { console.log('Error:', e); }}*/console.log('Done.');