@knowttl/technitium-axi 0.1.0 → 0.1.1

package/dist/write-contracts.js

@@ -0,0 +1,154 @@
+import { settingsFields, dhcpFields, identityFields } from './configuration.js';
+export const recordTypeNames = {
+    0: 'Unknown', 1: 'A', 2: 'NS', 3: 'MD', 4: 'MF', 5: 'CNAME', 6: 'SOA', 7: 'MB', 8: 'MG', 9: 'MR',
+    10: 'NULL', 11: 'WKS', 12: 'PTR', 13: 'HINFO', 14: 'MINFO', 15: 'MX', 16: 'TXT', 17: 'RP', 18: 'AFSDB',
+    19: 'X25', 20: 'ISDN', 21: 'RT', 22: 'NSAP', 23: 'NSAP_PTR', 24: 'SIG', 25: 'KEY', 26: 'PX', 27: 'GPOS',
+    28: 'AAAA', 29: 'LOC', 30: 'NXT', 31: 'EID', 32: 'NIMLOC', 33: 'SRV', 34: 'ATMA', 35: 'NAPTR', 36: 'KX',
+    37: 'CERT', 38: 'A6', 39: 'DNAME', 40: 'SINK', 41: 'OPT', 42: 'APL', 43: 'DS', 44: 'SSHFP', 45: 'IPSECKEY',
+    46: 'RRSIG', 47: 'NSEC', 48: 'DNSKEY', 49: 'DHCID', 50: 'NSEC3', 51: 'NSEC3PARAM', 52: 'TLSA', 53: 'SMIMEA',
+    55: 'HIP', 56: 'NINFO', 57: 'RKEY', 58: 'TALINK', 59: 'CDS', 60: 'CDNSKEY', 61: 'OPENPGPKEY', 62: 'CSYNC',
+    63: 'ZONEMD', 64: 'SVCB', 65: 'HTTPS', 99: 'SPF', 100: 'UINFO', 101: 'UID', 102: 'GID', 103: 'UNSPEC',
+    104: 'NID', 105: 'L32', 106: 'L64', 107: 'LP', 108: 'EUI48', 109: 'EUI64', 128: 'NXNAME', 249: 'TKEY',
+    250: 'TSIG', 251: 'IXFR', 252: 'AXFR', 253: 'MAILB', 254: 'MAILA', 255: 'ANY', 256: 'URI', 257: 'CAA',
+    258: 'AVC', 259: 'DOA', 260: 'AMTRELAY', 261: 'RESINFO', 262: 'WALLET', 263: 'CLA', 264: 'IPN',
+    32768: 'TA', 32769: 'DLV', 65280: 'ANAME', 65281: 'FWD', 65282: 'APP', 65283: 'CHILD_NS', 65284: 'PARENT_NS', 65357: 'ALIAS',
+};
+// Reviewed against DNS Server 0dd592aad21eced4221a9a46204cb1a299972ca0.
+// Selectors describe vendor matching, including composite keys and owner/type singletons.
+export const recordFamilies = {
+    A: { selector: ['ipAddress'], replacement: ['newIpAddress'], optional: ['ptr', 'createPtrZone', 'updateSvcbHints'] },
+    AAAA: { selector: ['ipAddress'], replacement: ['newIpAddress'], optional: ['ptr', 'createPtrZone', 'updateSvcbHints'] },
+    NS: { selector: ['nameServer'], replacement: ['newNameServer'], optional: ['glue'] },
+    CNAME: { selector: [], replacement: ['cname'] },
+    DNAME: { selector: [], replacement: ['dname'] },
+    PTR: { selector: ['ptrName'], replacement: ['newPtrName'] },
+    MX: { selector: ['preference', 'exchange'], replacement: ['newPreference', 'newExchange'] },
+    TXT: { selector: ['text'], replacement: ['newText'], optional: ['splitText', 'newSplitText', 'characterStringsBase64', 'newCharacterStringsBase64'] },
+    RP: { selector: ['mailbox', 'txtDomain'], replacement: ['newMailbox', 'newTxtDomain'] },
+    SRV: { selector: ['priority', 'weight', 'port', 'target'], replacement: ['newPriority', 'newWeight', 'newPort', 'newTarget'] },
+    NAPTR: { selector: ['naptrOrder', 'naptrPreference', 'naptrFlags', 'naptrServices', 'naptrRegexp', 'naptrReplacement'],
+        replacement: ['naptrNewOrder', 'naptrNewPreference', 'naptrNewFlags', 'naptrNewServices', 'naptrNewRegexp', 'naptrNewReplacement'] },
+    DS: { selector: ['keyTag', 'algorithm', 'digestType', 'digest'], replacement: ['newKeyTag', 'newAlgorithm', 'newDigestType', 'newDigest'] },
+    SSHFP: { selector: ['sshfpAlgorithm', 'sshfpFingerprintType', 'sshfpFingerprint'], replacement: ['newSshfpAlgorithm', 'newSshfpFingerprintType', 'newSshfpFingerprint'] },
+    TLSA: { selector: ['tlsaCertificateUsage', 'tlsaSelector', 'tlsaMatchingType', 'tlsaCertificateAssociationData'],
+        replacement: ['newTlsaCertificateUsage', 'newTlsaSelector', 'newTlsaMatchingType', 'newTlsaCertificateAssociationData'] },
+    SVCB: { selector: ['svcPriority', 'svcTargetName', 'svcParams'], replacement: ['newSvcPriority', 'newSvcTargetName', 'newSvcParams'], optional: ['autoIpv4Hint', 'autoIpv6Hint'] },
+    HTTPS: { selector: ['svcPriority', 'svcTargetName', 'svcParams'], replacement: ['newSvcPriority', 'newSvcTargetName', 'newSvcParams'], optional: ['autoIpv4Hint', 'autoIpv6Hint'] },
+    URI: { selector: ['uriPriority', 'uriWeight', 'uri'], replacement: ['newUriPriority', 'newUriWeight', 'newUri'] },
+    CAA: { selector: ['flags', 'tag', 'value'], replacement: ['newFlags', 'newTag', 'newValue'] },
+    ANAME: { selector: ['aname'], replacement: ['newAName'] },
+    FWD: { selector: ['protocol', 'forwarder'], replacement: ['newProtocol', 'newForwarder'],
+        optional: ['dnssecValidation', 'proxyType', 'proxyAddress', 'proxyPort', 'proxyUsername', 'proxyPassword', 'forwarderPriority'] },
+    APP: { selector: [], replacement: ['appName', 'classPath', 'recordData'] },
+    SOA: { selector: [], replacement: ['primaryNameServer', 'responsiblePerson', 'serial', 'refresh', 'retry', 'expire', 'minimum'], optional: ['useSerialDateScheme'] },
+    raw: { selector: ['rdata'], replacement: ['newRData'] },
+};
+const words = (value) => value.split(' ');
+const recordFields = [...new Set(Object.values(recordFamilies).flatMap(row => [...row.selector, ...row.replacement, ...row.optional ?? []]))];
+export const writeContracts = [
+    ...[
+        ['119', 'init', 'init', 'clusterDomain primaryNodeIpAddresses', 'clusterDomain primaryNodeIpAddresses'],
+        ['120', 'primary delete', 'primary/delete', 'node forceDelete', ''],
+        ['121', 'primary join', 'primary/join', 'secondaryNodeId secondaryNodeUrl secondaryNodeIpAddresses secondaryNodeCertificate', 'secondaryNodeId secondaryNodeUrl secondaryNodeIpAddresses secondaryNodeCertificate'],
+        ['122', 'primary remove-secondary', 'primary/removeSecondary', 'secondaryNodeId', 'secondaryNodeId'],
+        ['123', 'primary delete-secondary', 'primary/deleteSecondary', 'secondaryNodeId', 'secondaryNodeId'],
+        ['124', 'primary update-secondary', 'primary/updateSecondary', 'secondaryNodeId secondaryNodeUrl secondaryNodeIpAddresses secondaryNodeCertificate', 'secondaryNodeId secondaryNodeUrl secondaryNodeIpAddresses secondaryNodeCertificate'],
+        ['126', 'primary set-options', 'primary/setOptions', 'node heartbeatRefreshIntervalSeconds heartbeatRetryIntervalSeconds configRefreshIntervalSeconds configRetryIntervalSeconds', ''],
+        ['127', 'init-join', 'initJoin', 'secondaryNodeIpAddresses primaryNodeUrl primaryNodeIpAddress ignoreCertificateErrors primaryNodeUsername primaryNodePassword primaryNodeTotp', 'secondaryNodeIpAddresses primaryNodeUrl primaryNodeUsername primaryNodePassword'],
+        ['128', 'secondary leave', 'secondary/leave', 'node forceLeave', ''],
+        ['129', 'secondary notify', 'secondary/notify', 'primaryNodeId primaryNodeUrl primaryNodeIpAddresses', 'primaryNodeId primaryNodeUrl primaryNodeIpAddresses'],
+        ['130', 'secondary resync', 'secondary/resync', 'node', ''],
+        ['131', 'secondary update-primary', 'secondary/updatePrimary', 'node primaryNodeUrl primaryNodeIpAddresses', 'primaryNodeUrl'],
+        ['132', 'secondary promote', 'secondary/promote', 'node forceDeletePrimary', ''],
+        ['133', 'update-ip-address', 'updateIpAddress', 'node ipAddresses', 'ipAddresses'],
+    ].map(([id, command, path, fields, required]) => ({ id: `OP-${id}`, command: `admin cluster ${command}`, path: `/api/admin/cluster/${path}`,
+        fields: words(fields), required: required ? words(required) : [], ...(id === '127' ? { secrets: ['primaryNodePassword', 'primaryNodeTotp'] } : {}) })),
+    ...[
+        ['OP-087', 'remove', 'remove'], ['OP-088', 'convert-to-reserved', 'convertToReserved'], ['OP-089', 'convert-to-dynamic', 'convertToDynamic'],
+    ].map(([id, command, path]) => ({ id: id, command: `dhcp lease ${command}`, path: `/api/dhcp/leases/${path}`,
+        fields: words('name clientIdentifier hardwareAddress'), required: ['name'] })),
+    { id: 'OP-092', command: 'dhcp scope set', path: '/api/dhcp/scopes/set', fields: Object.keys(dhcpFields), required: ['name'], baselinePath: '/api/dhcp/scopes/get', baselineTarget: ['name'] },
+    { id: 'OP-093', command: 'dhcp scope add-reserved-lease', path: '/api/dhcp/scopes/addReservedLease', fields: words('name hardwareAddress ipAddress hostName comments'), required: words('name hardwareAddress ipAddress') },
+    { id: 'OP-094', command: 'dhcp scope remove-reserved-lease', path: '/api/dhcp/scopes/removeReservedLease', fields: words('name hardwareAddress'), required: words('name hardwareAddress') },
+    ...[['OP-095', 'enable'], ['OP-096', 'disable'], ['OP-097', 'delete']].map(([id, action]) => ({
+        id: id, command: `dhcp scope ${action}`, path: `/api/dhcp/scopes/${action}`, fields: ['name'], required: ['name'],
+    })),
+    { id: 'OP-002', command: 'user login', path: '/api/user/login', fields: words('user pass totp'), required: ['user', 'pass'], secrets: ['pass', 'totp'] },
+    { id: 'OP-003', command: 'user create-token', path: '/api/user/createToken', fields: words('user pass totp tokenName'), required: ['tokenName'], secrets: ['pass', 'totp'] },
+    { id: 'OP-004', command: 'user create-single-use-token', path: '/api/user/createSingleUseToken', fields: [], required: [] },
+    { id: 'OP-005', command: 'user logout', path: '/api/user/logout', fields: [], required: [] },
+    { id: 'OP-007', command: 'user session delete', path: '/api/user/session/delete', fields: ['partialToken'], required: ['partialToken'] },
+    { id: 'OP-008', command: 'user change-password', path: '/api/user/changePassword', fields: words('pass newPass totp iterations'), required: ['pass', 'newPass'], secrets: ['pass', 'newPass', 'totp'] },
+    { id: 'OP-009', command: 'user 2fa init', path: '/api/user/2fa/init', fields: [], required: [] },
+    { id: 'OP-010', command: 'user 2fa enable', path: '/api/user/2fa/enable', fields: ['totp'], required: ['totp'], secrets: ['totp'] },
+    { id: 'OP-011', command: 'user 2fa disable', path: '/api/user/2fa/disable', fields: [], required: [] },
+    { id: 'OP-013', command: 'user profile set', path: '/api/user/profile/set', fields: words('displayName sessionTimeoutSeconds'), required: [] },
+    { id: 'OP-099', command: 'admin session create-token', path: '/api/admin/sessions/createToken', fields: words('user tokenName'), required: words('user tokenName') },
+    { id: 'OP-100', command: 'admin session delete', path: '/api/admin/sessions/delete', fields: words('node partialToken'), required: ['partialToken'] },
+    { id: 'OP-102', command: 'admin user create', path: '/api/admin/users/create', fields: words('user pass displayName'), required: words('user pass'), secrets: ['pass'] },
+    { id: 'OP-104', command: 'admin user set', path: '/api/admin/users/set', fields: words('user displayName newUser totpEnabled disabled sessionTimeoutSeconds newPass iterations memberOfGroups'), required: ['user'], secrets: ['newPass'] },
+    { id: 'OP-105', command: 'admin user delete', path: '/api/admin/users/delete', fields: ['user'], required: ['user'] },
+    { id: 'OP-107', command: 'admin group create', path: '/api/admin/groups/create', fields: words('group description'), required: ['group'] },
+    { id: 'OP-110', command: 'admin group delete', path: '/api/admin/groups/delete', fields: ['group'], required: ['group'] },
+    { id: 'OP-113', command: 'admin permission set', path: '/api/admin/permissions/set', fields: words('node section userPermissions groupPermissions'), required: ['section'], baselinePath: '/api/admin/permissions/get', baselineTarget: words('node section') },
+    { id: 'OP-115', command: 'admin sso set', path: '/api/admin/sso/set', fields: Object.keys(identityFields).filter(key => key.startsWith('sso')), required: [], secrets: ['ssoClientSecret'] },
+    { id: 'OP-116', command: 'admin sso user create', path: '/api/admin/sso/users/create', fields: words('user displayName ssoIdentifier memberOfGroups'), required: words('user ssoIdentifier') },
+    { id: 'OP-117', command: 'admin sso user set', path: '/api/admin/sso/users/set', fields: words('user newUser displayName memberOfGroups'), required: ['user'] },
+    { id: 'OP-142', command: 'admin ldap set', path: '/api/admin/ldap/set', fields: Object.keys(identityFields).filter(key => key.startsWith('ldap')), required: [], secrets: ['ldapBindPassword'] },
+    { id: 'OP-019', command: 'dashboard stats delete-all', path: '/api/dashboard/stats/deleteAll', fields: ['node'], required: [] },
+    ...[
+        ['OP-054', 'cache', 'delete', 'domain'], ['OP-055', 'cache', 'flush', ''],
+        ['OP-057', 'allowed', 'add', 'domain'], ['OP-058', 'allowed', 'delete', 'domain'],
+        ['OP-059', 'allowed', 'flush', ''], ['OP-060', 'allowed', 'import', 'allowedZones'],
+        ['OP-063', 'blocked', 'add', 'domain'], ['OP-064', 'blocked', 'delete', 'domain'],
+        ['OP-065', 'blocked', 'flush', ''], ['OP-066', 'blocked', 'import', 'blockedZones'],
+    ].map(([id, family, action, field]) => ({ id: id, command: `${family} ${action}`, path: `/api/${family}/${action}`,
+        fields: field ? [field] : [], required: field ? [field] : [] })),
+    { id: 'OP-022', command: 'zone create', path: '/api/zones/create', fields: words('node zone type catalog useSoaSerialDateScheme primaryNameServerAddresses zoneTransferProtocol tsigKeyName validateZone initializeForwarder protocol forwarder dnssecValidation proxyType proxyAddress proxyPort proxyUsername proxyPassword'), required: ['zone', 'type'], secrets: ['proxyPassword'] },
+    { id: 'OP-023', command: 'zone import', path: '/api/zones/import', fields: words('node zone overwrite overwriteZone overwriteSoaSerial records'), required: ['zone'] },
+    { id: 'OP-025', command: 'zone clone', path: '/api/zones/clone', fields: words('node zone sourceZone'), required: ['zone', 'sourceZone'] },
+    { id: 'OP-026', command: 'zone convert', path: '/api/zones/convert', fields: words('node zone type'), required: ['zone', 'type'] },
+    ...[['OP-027', 'enable'], ['OP-028', 'disable'], ['OP-029', 'delete'], ['OP-030', 'resync']].map(([id, action]) => ({
+        id: id, command: `zone ${action}`, path: `/api/zones/${action}`, fields: words(action === 'delete' ? 'node zone zones' : 'node zone'), required: action === 'delete' ? [] : ['zone'],
+    })),
+    { id: 'OP-032', command: 'zone options set', path: '/api/zones/options/set', fields: words('node zone disabled catalog overrideCatalogQueryAccess overrideCatalogZoneTransfer overrideCatalogNotify primaryNameServerAddresses primaryZoneTransferProtocol primaryZoneTransferTsigKeyName validateZone queryAccess queryAccessNetworkACL zoneTransfer zoneTransferNetworkACL zoneTransferTsigKeyNames notify notifyNameServers notifySecondaryCatalogsNameServers update updateNetworkACL updateSecurityPolicies'), required: ['zone'], baselinePath: '/api/zones/options/get', baselineTarget: ['zone', 'node'] },
+    { id: 'OP-034', command: 'zone permission set', path: '/api/zones/permissions/set', fields: words('node zone userPermissions groupPermissions'), required: ['zone'], baselinePath: '/api/zones/permissions/get', baselineTarget: ['zone', 'node'] },
+    { id: 'OP-035', command: 'zone dnssec sign', path: '/api/zones/dnssec/sign', fields: words('node zone algorithm pemKskPrivateKey pemZskPrivateKey hashAlgorithm kskKeySize zskKeySize curve dnsKeyTtl zskRolloverDays nxProof iterations saltLength'), required: ['zone', 'algorithm'], secrets: ['pemKskPrivateKey', 'pemZskPrivateKey'] },
+    { id: 'OP-036', command: 'zone dnssec unsign', path: '/api/zones/dnssec/unsign', fields: words('node zone'), required: ['zone'] },
+    ...[
+        ['OP-039', 'convert-to-nsec', 'convertToNSEC', '', ''],
+        ['OP-040', 'convert-to-nsec3', 'convertToNSEC3', 'iterations saltLength', ''],
+        ['OP-041', 'update-nsec3-params', 'updateNSEC3Params', 'iterations saltLength', ''],
+        ['OP-042', 'update-dns-key-ttl', 'updateDnsKeyTtl', 'ttl', 'ttl'],
+        ['OP-044', 'update-private-key', 'updatePrivateKey', 'keyTag rolloverDays', 'keyTag rolloverDays'],
+        ['OP-045', 'delete-private-key', 'deletePrivateKey', 'keyTag', 'keyTag'],
+        ['OP-046', 'publish-all-private-keys', 'publishAllPrivateKeys', '', ''],
+        ['OP-047', 'rollover-dns-key', 'rolloverDnsKey', 'keyTag', 'keyTag'],
+        ['OP-048', 'retire-dns-key', 'retireDnsKey', 'keyTag', 'keyTag'],
+    ].map(([id, command, path, fields, required]) => ({ id: id, command: `zone dnssec properties ${command}`, path: `/api/zones/dnssec/properties/${path}`,
+        fields: words(`node zone ${fields}`.trim()), required: words(`zone ${required}`.trim()) })),
+    { id: 'OP-140', command: 'zone dnssec properties activate-ksk-dns-key', path: '/api/zones/dnssec/properties/activateKskDnsKey', fields: words('zone keyTag'), required: words('zone keyTag') },
+    { id: 'OP-043', command: 'zone dnssec properties add-private-key', path: '/api/zones/dnssec/properties/addPrivateKey', fields: words('node zone keyType rolloverDays algorithm pemPrivateKey hashAlgorithm keySize curve'), required: ['zone', 'keyType', 'algorithm'], secrets: ['pemPrivateKey'] },
+    ...[['OP-049', 'add'], ['OP-051', 'update'], ['OP-052', 'delete']].map(([id, action]) => ({ id: id, command: `zone record ${action}`, path: `/api/zones/records/${action}`,
+        fields: [...words('node zone domain type ttl overwrite comments expiryTtl newDomain disable'), ...recordFields], required: ['zone', 'domain', 'type'], secrets: ['proxyPassword'] })),
+    { id: 'OP-077', command: 'dns-client resolve', path: '/api/dnsClient/resolve', fields: words('node server domain type protocol dnssec eDnsClientSubnet import'), required: ['server', 'domain', 'type'] },
+    { id: 'OP-080', command: 'settings set', path: '/api/settings/set', fields: Object.keys(settingsFields), required: [], secrets: Object.keys(settingsFields).filter(key => settingsFields[key].secret), baselinePath: '/api/settings/get', baselineTarget: [] },
+    { id: 'OP-082', command: 'settings force-update-block-lists', path: '/api/settings/forceUpdateBlockLists', fields: [], required: [] },
+    { id: 'OP-083', command: 'settings temporary-disable-blocking', path: '/api/settings/temporaryDisableBlocking', fields: ['minutes'], required: ['minutes'] },
+    ...[
+        ['OP-070', 'download-and-install', 'downloadAndInstall'],
+        ['OP-071', 'download-and-update', 'downloadAndUpdate'],
+        ['OP-074', 'uninstall', 'uninstall'],
+    ].map(([id, command, path]) => ({ id: id, command: `app ${command}`, path: `/api/apps/${path}`,
+        fields: command === 'uninstall' ? ['name'] : ['name', 'url'], required: command === 'uninstall' ? ['name'] : ['name', 'url'] })),
+    { id: 'OP-076', command: 'app config set', path: '/api/apps/config/set', fields: ['name', 'config'], required: ['name', 'config'], secrets: ['config'] },
+    { id: 'OP-072', command: 'app install', path: '/api/apps/install', fields: ['node', 'name'], required: ['name'] },
+    { id: 'OP-073', command: 'app update', path: '/api/apps/update', fields: ['node', 'name'], required: ['name'] },
+    { id: 'OP-085', command: 'settings restore', path: '/api/settings/restore', fields: words('node authConfig clusterConfig webServiceSettings dnsSettings logSettings zones allowedZones blockedZones blockLists apps scopes stats logs deleteExistingFiles'), required: [] },
+    { id: 'OP-136', command: 'log delete', path: '/api/logs/delete', fields: ['node', 'log'], required: ['log'] },
+    { id: 'OP-137', command: 'log delete-all', path: '/api/logs/deleteAll', fields: ['node'], required: [] },
+    { id: 'OP-109', command: 'admin group set', path: '/api/admin/groups/set', fields: words('group newGroup description members'), required: ['group'], baselinePath: '/api/admin/groups/get', baselineTarget: ['group'] },
+    { id: 'OP-143', command: 'admin ldap test', path: '/api/admin/ldap/test', fields: words('ldapServer ldapPort ldapSslOption ldapIgnoreSslErrors ldapBindUsername ldapBindPassword ldapSearchBase ldapUserSearchFilter ldapGroupAttribute'), required: [], secrets: ['ldapBindPassword'] },
+];
+export const writeFlags = ['--json', '--help', '--config', '--profile', '--input-file', '--execute', '--confirm', '--result-file', '--reconcile'];
+export const writeCapabilities = writeContracts.flatMap(row => row.id === 'OP-077' ? ['OP-077.import'] : [row.id]);