cjdns admin herunterladen - cjdns admin Quellcode herunterladen

️ CJDNS ist eine gute Technologie, aber die meisten Leute um sie herum sind ein Haufen intoleranter und feindseliger Kommunismus-Abschaum. Wenn Sie dieses Modul übernehmen und mit diesen Leuten umgehen möchten, erstellen Sie bitte ein Problem und wir kümmern uns darum. Danke

cjdns-admin

Ein NodeJS-Modul für die Arbeit mit der CJDNS-Administratorschnittstelle über UDP. Es ist konsistent, robust und einfach zu bedienen.

Springen:

Erstellen Sie ein Admin-Objekt
CJDNS-Administratorfunktionen
Ausgelagerte Funktionen
Entwicklung

Installieren

Es ist über npm verfügbar

 npm install cjdns-admin

createAdmin-Konstruktor

Die Funktion createAdmin gibt einen EventEmitter4 mit Mitgliedern für jede Admin-Funktion und deren Stellvertreter zurück. Es enthält auch Mitglieder, die das automatische Paging für ausgelagerte Funktionen verwalten.

Optionen:

ip, string, optional
Port, Nummer, optional
Passwort, Zeichenfolge, erforderlich

Verwendung:

 var cjdnsAdmin = require ( 'cjdns-admin' ) ,
    admin ,
    channel ;

// create a new Admin
admin = cjdnsAdmin . createAdmin ( {
    ip : '127.0.0.1' ,
    port : 11234 ,
    password : 'my cjdns password'
} ) ;

// ping the admin
channel = admin . ping ( ) ;

// create a response handler
function pingResponse ( res ) {
    // process ping response
    console . dir ( res ) ;
}

// handle the response
admin . on ( channel , pingResponse ) ;

CJDNS-Administratorfunktionen

Original: so benannt, wie CJDNS sie nennt
Alternativ: im Einklang mit der normalen JS-Funktionsnomenklatur
Darunter rufen sie die gleiche Funktion auf

Original	Wechseln
Admin_asyncEnabled	admin.asyncEnabled
Admin_availableFunctions	admin.availableFunctions
	admin.availableFunctionsPaged
AdminLog_logMany	log.logMany
AdminLog_subscribe	log.subscribe
AdminLog_subscriptions	log.subscriptions
AdminLog_unsubscribe	log.unsubscribe
Allocator_bytesAllocated	allocator.bytesAllocated
Allocator_snapshot	allocator.snapshot
AuthorizedPasswords_add	autorisiertePasswörter.add
AutorisiertePasswortliste	autorisiertePasswörter.list
AuthorizedPasswords_remove	autorisiertePasswörter.remove
Core_exit	core.exit
Core_initTunnel	core.initTunnel
Core_pid	core.pid
InterfaceController_disconnectPeer	interfaceController.disconnectPeer
InterfaceController_peerStats	interfaceController.peerStats
	interfaceController.peerStatsPaged
IpTunnel_allowConnection	ipTunnel.allowConnection
IpTunnel_connectTo	ipTunnel.connectTo
IpTunnel_listConnections	ipTunnel.listConnections
IpTunnel_removeConnection	ipTunnel.removeConnection
IpTunnel_showConnection	ipTunnel.showConnection
Janitor_dumpRumorMill	janitor.dumpRumorMill
Erinnerung	admin.memory
	nodeStore.dumpTablePaged
NodeStore_getLink	nodeStore.getLink
NodeStore_getRouteLabel	nodeStore.getRouteLabel
NodeStore_nodeForAddr	nodeStore.nodeForAddr
Klingeln	admin.ping
RouterModule_findNode	routerModule.findNode
RouterModule_getPeers	routerModule.getPeers
RouterModule_lookup	routerModule.lookup
RouterModule_nextHop	routerModule.nextHop
RouterModule_pingNode	routerModule.pingNode
SearchRunner_showActiveSearch	searchRunner.showActiveSearch
SearchRunner_search	searchRunner.search
Security_checkPermissions	security.checkPermissions
Security_chroot	security.chroot
Security_getUser	security.getUser
Security_nofiles	security.nofiles
Security_noforks	security.noforks
Security_seccomp	security.seccomp
Security_setupComplete	security.setupComplete
Security_setUser	security.setUser
SessionManager_getHandles	sessionManager.getHandles
	sessionManager.getHandlesPaged
SessionManager_sessionStats	sessionManager.sessionStats
SwitchPinger_ping	switchPinger.ping
UDPInterface_beginConnection	udpInterface.beginConnection
UDPInterface_new	udpInterface.neu

Admin_asyncEnabled, admin.asyncEnabled

Verwendung:

 channel = admin . asyncEnabled ( ) ;
admin . once ( channel , processResponse ) ;

Admin_availableFunctions, admin.availableFunctions

Seite, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    page : 0
} ;

channel = admin . availableFunctions ( options ) ;
admin . once ( channel , processResponse ) ;

AdminLog_logMany, log.logMany

count, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    count : 0
} ;

channel = admin . log . logMany ( options ) ;
admin . once ( channel , processResponse ) ;

AdminLog_subscribe, log.subscribe

Datei, Zeichenfolge, optional
Ebene, Zeichenfolge, optional
Zeile, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    file : '' ,
    level : '' ,
    line : 0
} ;

channel = admin . log . subscribe ( options ) ;
admin . once ( channel , processResponse ) ;

AdminLog_subscriptions, log.subscriptions

Verwendung:

 channel = admin . log . subscriptions ( ) ;
admin . once ( channel , processResponse ) ;

AdminLog_unsubscribe, log.unsubscribe

streamId, string, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    streamId : ''
} ;

channel = admin . log . unsubscribe ( options ) ;
admin . once ( channel , processResponse ) ;

Allocator_bytesAllocated, allocator.bytesAllocated

Verwendung:

 channel = admin . allocator . bytesAllocated ( ) ;
admin . once ( channel , processResponse ) ;

Allocator_snapshot, allocator.snapshot

includeAllocations, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    includeAllocations : 0
} ;

channel = admin . allocator . snapshot ( options ) ;
admin . once ( channel , processResponse ) ;

AuthorizedPasswords_add,authorizedPasswords.add

authType, int, optional
ipv6, string, optional
Passwort, Zeichenfolge, erforderlich
Benutzer, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    authType : 0 ,
    ipv6 : '' ,
    password : '' ,
    user : ''
} ;

channel = admin . authorizedPasswords . add ( options ) ;
admin . once ( channel , processResponse ) ;

AutorisiertePasswortliste, autorisiertePasswortliste

Verwendung:

 channel = admin . authorizedPasswords . list ( ) ;
admin . once ( channel , processResponse ) ;

AuthorizedPasswords_remove,authorizedPasswords.remove

Benutzer, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    user : ''
} ;

channel = admin . authorizedPasswords . remove ( options ) ;
admin . once ( channel , processResponse ) ;

Core_exit, core.exit

Verwendung:

 channel = admin . core . exit ( ) ;
admin . once ( channel , processResponse ) ;

Core_initTunnel, core.initTunnel

gewünschterTunName, Zeichenfolge, optional

Verwendung:

 var channel ,
    options ;

options = {
    desiredTunName : ''
} ;

channel = admin . core . initTunnel ( options ) ;
admin . once ( channel , processResponse ) ;

Core_pid, core.pid

Verwendung:

 channel = admin . core . pid ( ) ;
admin . once ( channel , processResponse ) ;

InterfaceController_disconnectPeer, interfaceController.disconnectPeer

pubkey, string, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    pubkey : ''
} ;

channel = admin . interfaceController . disconnectPeer ( options ) ;
admin . once ( channel , processResponse ) ;

InterfaceController_peerStats, interfaceController.peerStats

Seite, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    page : 0
} ;

channel = admin . interfaceController . peerStats ( options ) ;
admin . once ( channel , processResponse ) ;

IpTunnel_allowConnection, ipTunnel.allowConnection

ip4Address, string, optional
ip4Prefix, int, optional
ip6Address, string, optional
ip6Prefix, int, optional
publicKeyOfAuthorizedNode, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    ip4Address : '' ,
    ip4Prefix : 0 ,
    ip6Address : '' ,
    ip6Prefix : 0 ,
    publicKeyOfAuthorizedNode : ''
} ;

channel = admin . ipTunnel . allowConnection ( options ) ;
admin . once ( channel , processResponse ) ;

IpTunnel_connectTo, ipTunnel.connectTo

publicKeyOfNodeToConnectTo, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    publicKeyOfNodeToConnectTo : ''
} ;

channel = admin . ipTunnel . connectTo ( options ) ;
admin . once ( channel , processResponse ) ;

IpTunnel_listConnections, ipTunnel.listConnections

Verwendung:

 channel = admin . ipTunnel . listConnections ( ) ;
admin . once ( channel , processResponse ) ;

IpTunnel_removeConnection, ipTunnel.removeConnection

Verbindung, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    connection : 0
} ;

channel = admin . ipTunnel . removeConnection ( options ) ;
admin . once ( channel , processResponse ) ;

IpTunnel_showConnection, ipTunnel.showConnection

Verbindung, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    connection : 0
} ;

channel = admin . ipTunnel . showConnection ( options ) ;
admin . once ( channel , processResponse ) ;

Janitor_dumpRumorMill, janitor.dumpRumorMill

Mühle, Schnur, erforderlich
page, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    mill : '' ,
    page : 0
} ;

channel = admin . janitor . dumpRumorMill ( options ) ;
admin . once ( channel , processResponse ) ;

Speicher, admin.memory

Verwendung:

 channel = admin . memory ( ) ;
admin . once ( channel , processResponse ) ;

NodeStore_dumpTable, nodeStore.dumpTable

page, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    page : 0
} ;

channel = admin . nodeStore . dumpTable ( options ) ;
admin . once ( channel , processResponse ) ;

NodeStore_getLink, nodeStore.getLink

linkNum, int, erforderlich
übergeordnetes Element, Zeichenfolge, optional

Verwendung:

 var channel ,
    options ;

options = {
    linkNum : 0 ,
    parent : ''
} ;

channel = admin . nodeStore . getLink ( options ) ;
admin . once ( channel , processResponse ) ;

NodeStore_getRouteLabel, nodeStore.getRouteLabel

pathParentToChild, Zeichenfolge, erforderlich
pathToParent, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    pathParentToChild : '' ,
    pathToParent : ''
} ;

channel = admin . nodeStore . getRouteLabel ( options ) ;
admin . once ( channel , processResponse ) ;

NodeStore_nodeForAddr, nodeStore.nodeForAddr

ip, string, optional

Verwendung:

 var channel ,
    options ;

options = {
    ip : ''
} ;

channel = admin . nodeStore . nodeForAddr ( options ) ;
admin . once ( channel , processResponse ) ;

ping, admin.ping

Verwendung:

 channel = admin . ping ( ) ;
admin . once ( channel , processResponse ) ;

RouterModule_findNode, routerModule.findNode

nodeToQuery, Zeichenfolge, erforderlich
Ziel, Zeichenfolge, erforderlich
Timeout, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    nodeToQuery : '' ,
    target : '' ,
    timeout : 0
} ;

channel = admin . routerModule . findNode ( options ) ;
admin . once ( channel , processResponse ) ;

RouterModule_getPeers, routerModule.getPeers

nearPath, string, optional
Pfad, Zeichenfolge, erforderlich
Timeout, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    nearbyPath : '' ,
    path : '' ,
    timeout : 0
} ;

channel = admin . routerModule . getPeers ( options ) ;
admin . once ( channel , processResponse ) ;

RouterModule_lookup, routerModule.lookup

Adresse, Zeichenfolge, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    address : ''
} ;

channel = admin . routerModule . lookup ( options ) ;
admin . once ( channel , processResponse ) ;

RouterModule_nextHop, routerModule.nextHop

nodeToQuery, Zeichenfolge, erforderlich
Ziel, Zeichenfolge, erforderlich
Timeout, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    nodeToQuery : '' ,
    target : '' ,
    timeout : 0
} ;

channel = admin . routerModule . nextHop ( options ) ;
admin . once ( channel , processResponse ) ;

RouterModule_pingNode, routerModule.pingNode

Pfad, Zeichenfolge, erforderlich
Timeout, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    path : '' ,
    timeout : 0
} ;

channel = admin . routerModule . pingNode ( options ) ;
admin . once ( channel , processResponse ) ;

SearchRunner_search, searchRunner.search

ipv6, Zeichenfolge, erforderlich
maxRequests, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    ipv6 : '' ,
    maxRequests : 0
} ;

channel = admin . searchRunner . search ( options ) ;
admin . once ( channel , processResponse ) ;

SearchRunner_showActiveSearch, searchRunner.showActiveSearch

Zahl, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    number : 0
} ;

channel = admin . searchRunner . showActiveSearch ( options ) ;
admin . once ( channel , processResponse ) ;

Security_checkPermissions, security.checkPermissions

Verwendung:

 channel = admin . security . checkPermissions ( ) ;
admin . once ( channel , processResponse ) ;

Security_chroot, security.chroot

root, string, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    root : ''
} ;

channel = admin . security . chroot ( options ) ;
admin . once ( channel , processResponse ) ;

Security_getUser, security.getUser

Benutzer, Zeichenfolge, optional

Verwendung:

 var channel ,
    options ;

options = {
    user : ''
} ;

channel = admin . security . getUser ( options ) ;
admin . once ( channel , processResponse ) ;

Security_nofiles, security.nofiles

Verwendung:

 channel = admin . security . nofiles ( ) ;
admin . once ( channel , processResponse ) ;

Security_noforks, security.noforks

Verwendung:

 channel = admin . security . noforks ( ) ;
admin . once ( channel , processResponse ) ;

Security_seccomp, security.seccomp

Verwendung:

 channel = admin . security . seccomp ( ) ;
admin . once ( channel , processResponse ) ;

Security_setupComplete, security.setupComplete

Verwendung:

 channel = admin . security . setupComplete ( ) ;
admin . once ( channel , processResponse ) ;

Security_setUser, security.setUser

keepNetAdmin, int, erforderlich
uid, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    keepNetAdmin : 0 ,
    uid : 0
} ;

channel = admin . security . setUser ( options ) ;
admin . once ( channel , processResponse ) ;

SessionManager_getHandles, sessionManager.getHandles

Seite, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    page : 0
} ;

channel = admin . sessionManager . getHandles ( options ) ;
admin . once ( channel , processResponse ) ;

SessionManager_sessionStats, sessionManager.sessionStats

handle, int, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    handle : 0
} ;

channel = admin . sessionManager . sessionStats ( options ) ;
admin . once ( channel , processResponse ) ;

SwitchPinger_ping, switchPinger.ping

Daten, Zeichenfolge, optional
keyPing, int, optional
Pfad, Zeichenfolge, erforderlich
Timeout, int, optional

Verwendung:

 var channel ,
    options ;

options = {
    data : '' ,
    keyPing : 0 ,
    path : '' ,
    timeout : 0
} ;

channel = admin . switchPinger . ping ( options ) ;
admin . once ( channel , processResponse ) ;

UDPInterface_beginConnection, udpInterface.beginConnection

Adresse, Zeichenfolge, erforderlich
interfaceNumber, int, optional
Passwort, Zeichenfolge, optional
publicKey, string, erforderlich

Verwendung:

 var channel ,
    options ;

options = {
    address : '' ,
    interfaceNumber : 0 ,
    password : '' ,
    publicKey : ''
} ;

channel = admin . udpInterface . beginConnection ( options ) ;
admin . once ( channel , processResponse ) ;

UDPInterface_new, udpInterface.new

bindAddress, string, optional

Verwendung:

 var channel ,
    options ;

options = {
    bindAddress : ''
} ;

channel = admin . udpInterface . new ( options ) ;
admin . once ( channel , processResponse ) ;

Ausgelagerte Funktionen

Die ausgelagerten Funktionen rufen alle Seiten ab und geben das Ergebnis zurück. Das Übergeben von Optionen ist optional. Der Rückruf empfängt err und results als Argumente und beide sind Array -Typen.

 function pagedCallback ( err , results ) {
    if ( err ) {
        return console . log ( 'paged callback error' , err ) ;
    }
    console . log ( 'paged function results array' , ) ;
}
admin . availableFunctionsPaged ( pagedCallback ) ;
admin . interfaceController . peerStatsPaged ( pagedCallback ) ;
admin . nodeStore . dumpTablePaged ( pagedCallback ) ;
admin . sessionManager . getHandlesPaged ( pagedCallback ) ;

// mill property is optional
admin . janitor . dumpRumorMillPaged ( { mill : '' } , pagedCallback ) ;

Entwicklung

Erstellen Sie Umgebungsvariablen, nach denen die Tests suchen:

 # cjdns development environment
export CJDNS_ADMIN_PORT=11234
export CJDNS_ADMIN_IP=127.0.0.1
export CJDNS_ADMIN_PASSWORD=from your cjdroute config

Tools sind über npm-Skripte verfügbar. Siehe package.json im Abschnitt scripts .

 npm run lint

# test offline functionality
npm test
npm test -- --watch

# test online, UDP, and potentially dangerous functions
# on an actual node
npm run test-live
npm run test-live -- --watch

# render docs to html for testing
npm run doc-gen
npm run doc-watch

Expandieren