cjdns admin

️ CJDNS 是一项很好的技术，但它周围的大多数人都是一群不宽容和敌对的共产败类。如果您想接管这个模块并与这些人打交道，请制作并发布，我们会解决这个问题。谢谢

cjdns管理

---

用于通过 UDP 处理 CJDNS 管理界面的 Nodejs 模块。它具有一致、稳健且易于使用的特点。

跳：

• 创建管理对象
• CJDNS管理功能
• 分页功能
• 发展

安装

---

它可以通过 npm 获得

 npm install cjdns-admin

创建管理构造函数

---

createAdmin函数返回一个 EventEmitter4，其中包含每个管理函数及其备用函数的成员。它还包含处理分页功能的自动分页的成员。

选项：

• ip，字符串，可选
• 端口、数量、可选
• 密码，字符串，必填

用法：

 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管理功能

• 原文：与 CJDNS 的命名相同
• 替代：与普通 JS 函数命名法一致
• 在下面他们调用相同的函数

原来的	备用
Admin_asyncEnabled	admin.asyncEnabled
Admin_availableFunctions	admin.availableFunctions
	admin.availableFunctionsPaged
AdminLog_logMany	log.logMany
管理日志_订阅	日志订阅
管理日志_订阅	日志订阅
AdminLog_取消订阅	取消订阅日志
Allocator_bytes已分配	分配器.bytes已分配
分配器快照	分配器.快照
授权密码_add	授权密码.add
授权密码列表	授权密码列表
授权密码_删除	授权密码.remove
核心退出	核心退出
Core_initTunnel	core.initTunnel
核心进程号	核心.pid
InterfaceController_disconnectPeer	接口Controller.disconnectPeer
InterfaceController_peerStats	接口控制器.peerStats
	接口控制器.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
记忆	管理内存
	nodeStore.dumpTablePaged
NodeStore_getLink	节点存储.getLink
NodeStore_getRouteLabel	nodeStore.getRouteLabel
NodeStore_nodeForAddr	节点存储.nodeForAddr
平	管理.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
安全_chroot	安全.chroot
安全获取用户	安全.getUser
安全_nofiles	安全.nofiles
安全_noforks	安全.noforks
安全_seccomp	安全.seccomp
安全设置完成	安全.setupComplete
安全设置用户	安全性.setUser
SessionManager_getHandles	sessionManager.getHandles
	sessionManager.getHandlesPaged
SessionManager_sessionStats	sessionManager.sessionStats
SwitchPinger_ping	switchPinger.ping
UDPInterface_beginConnection	udpInterface.beginConnection
UDP接口_new	udp接口.new

Admin_asyncEnabled、admin.asyncEnabled

用法：

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

Admin_availableFunctions，admin.availableFunctions

• 页，整数，可选

用法：

 var channel ,
    options ;

options = {
    page : 0
} ;

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

AdminLog_logMany、log.logMany

• 计数，整数，必需

用法：

 var channel ,
    options ;

options = {
    count : 0
} ;

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

AdminLog_subscribe，log.subscribe

• 文件、字符串、可选
• 级别，字符串，可选
• 行，整数，可选

用法：

 var channel ,
    options ;

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

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

AdminLog_subscriptions、log.subscriptions

用法：

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

AdminLog_unsubscribe，log.unsubscribe

• StreamId，字符串，必填

用法：

 var channel ,
    options ;

options = {
    streamId : ''
} ;

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

Allocator_bytes已分配，allocator.bytes已分配

用法：

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

Allocator_snapshot, 分配器.snapshot

• includeAllocations，int，可选

用法：

 var channel ,
    options ;

options = {
    includeAllocations : 0
} ;

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

AuthorizedPasswords_add、authorizedPasswords.add

• authType，int，可选
• ipv6，字符串，可选
• 密码，字符串，必填
• 用户，字符串，必填

用法：

 var channel ,
    options ;

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

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

AuthorizedPasswords_list、authorizedPasswords.list

用法：

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

AuthorizedPasswords_remove、authorizedPasswords.remove

• 用户，字符串，必填

用法：

 var channel ,
    options ;

options = {
    user : ''
} ;

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

core_exit, core.exit

用法：

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

Core_initTunnel, core.initTunnel

• desiredTunName，字符串，可选

用法：

 var channel ,
    options ;

options = {
    desiredTunName : ''
} ;

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

core_pid, core.pid

用法：

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

InterfaceController_disconnectPeer，interfaceController.disconnectPeer

• 公钥，字符串，必需

用法：

 var channel ,
    options ;

options = {
    pubkey : ''
} ;

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

InterfaceController_peerStats，interfaceController.peerStats

• 页，整数，可选

用法：

 var channel ,
    options ;

options = {
    page : 0
} ;

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

IpTunnel_allowConnection、ipTunnel.allowConnection

• ip4地址，字符串，可选
• ip4Prefix，整数，可选
• ip6地址，字符串，可选
• ip6Prefix，整数，可选
• publicKeyOfAuthorizedNode，字符串，必需

用法：

 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，字符串，必需

用法：

 var channel ,
    options ;

options = {
    publicKeyOfNodeToConnectTo : ''
} ;

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

IpTunnel_listConnections、ipTunnel.listConnections

用法：

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

IpTunnel_removeConnection、ipTunnel.removeConnection

• 连接，整数，必需

用法：

 var channel ,
    options ;

options = {
    connection : 0
} ;

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

IpTunnel_showConnection、ipTunnel.showConnection

• 连接，整数，必需

用法：

 var channel ,
    options ;

options = {
    connection : 0
} ;

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

Janitor_dumpRumorMill, janitor.dumpRumorMill

• 磨机、绳子、必填
• 页，整数，必需

用法：

 var channel ,
    options ;

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

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

内存，管理内存

用法：

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

NodeStore_dumpTable、nodeStore.dumpTable

• 页，整数，必需

用法：

 var channel ,
    options ;

options = {
    page : 0
} ;

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

NodeStore_getLink、nodeStore.getLink

• linkNum，int，必填
• 父级，字符串，可选

用法：

 var channel ,
    options ;

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

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

NodeStore_getRouteLabel、nodeStore.getRouteLabel

• pathParentToChild，字符串，必填
• pathToParent，字符串，必需

用法：

 var channel ,
    options ;

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

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

NodeStore_nodeForAddr，nodeStore.nodeForAddr

• ip，字符串，可选

用法：

 var channel ,
    options ;

options = {
    ip : ''
} ;

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

ping，管理.ping

用法：

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

RouterModule_findNode，routerModule.findNode

• nodeToQuery，字符串，必填
• 目标，字符串，必需
• 超时，整数，可选

用法：

 var channel ,
    options ;

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

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

RouterModule_getPeers，routerModule.getPeers

• 附近路径，字符串，可选
• 路径，字符串，必填
• 超时，整数，可选

用法：

 var channel ,
    options ;

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

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

RouterModule_lookup、routerModule.lookup

• 地址，字符串，必填

用法：

 var channel ,
    options ;

options = {
    address : ''
} ;

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

RouterModule_nextHop，routerModule.nextHop

• nodeToQuery，字符串，必填
• 目标，字符串，必需
• 超时，整数，可选

用法：

 var channel ,
    options ;

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

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

RouterModule_pingNode、routerModule.pingNode

• 路径，字符串，必填
• 超时，整数，可选

用法：

 var channel ,
    options ;

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

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

SearchRunner_search，searchRunner.search

• ipv6，字符串，必填
• maxRequests，整数，可选

用法：

 var channel ,
    options ;

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

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

SearchRunner_showActiveSearch、searchRunner.showActiveSearch

• 数字，整数，必填

用法：

 var channel ,
    options ;

options = {
    number : 0
} ;

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

security_checkPermissions、security.checkPermissions

用法：

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

安全_chroot、安全.chroot

• 根，字符串，必需

用法：

 var channel ,
    options ;

options = {
    root : ''
} ;

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

安全_getUser、安全.getUser

• 用户，字符串，可选

用法：

 var channel ,
    options ;

options = {
    user : ''
} ;

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

安全_nofiles、安全.nofiles

用法：

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

安全_noforks，安全.noforks

用法：

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

安全_seccomp，安全.seccomp

用法：

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

安全_setupComplete，安全.setupComplete

用法：

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

安全_setUser、安全.setUser

• keepNetAdmin，int，必需
• uid，整数，必需

用法：

 var channel ,
    options ;

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

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

SessionManager_getHandles、sessionManager.getHandles

• 页，整数，可选

用法：

 var channel ,
    options ;

options = {
    page : 0
} ;

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

SessionManager_sessionStats，sessionManager.sessionStats

• 句柄，整数，必需

用法：

 var channel ,
    options ;

options = {
    handle : 0
} ;

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

SwitchPinger_ping，switchPinger.ping

• 数据，字符串，可选
• keyPing，整数，可选
• 路径，字符串，必填
• 超时，整数，可选

用法：

 var channel ,
    options ;

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

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

UDPInterface_beginConnection，udpInterface.beginConnection

• 地址，字符串，必填
• 接口编号，int，可选
• 密码，字符串，可选
• 公钥，字符串，必填

用法：

 var channel ,
    options ;

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

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

UDPInterface_new，udpInterface.new

• 绑定地址，字符串，可选

用法：

 var channel ,
    options ;

options = {
    bindAddress : ''
} ;

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

---

分页功能

分页函数将获取所有页面并返回结果。传递选项是可选的。回调接收err和results作为参数，两者都是Array类型。

 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 ) ; 

---

发展

创建测试将查找的环境变量：

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

工具可通过 npm 脚本获得。请参阅scripts部分中的package.json 。

 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