cjdns admin

️ CJDNS は優れたテクノロジーですが、その周りにいる人々のほとんどは不寛容で敵対的な共産主義者の集まりです。このモジュールを引き継いでそれらの人々に対処したい場合は、作成して発行してください。私たちが解決します。ありがとう

cjdns-管理者

---

UDP 経由で CJDNS 管理インターフェイスを操作するための nodejs モジュール。一貫性があり、堅牢で使いやすいように作られています。

ジャンプ：

• 管理者オブジェクトの作成
• CJDNS管理機能
• ページ化された関数
• 発達

インストール

---

npm経由で利用可能です

 npm install cjdns-admin

createAdmin コンストラクター

---

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.availableFunctionsPages
AdminLog_logMany	ログ.logMany
AdminLog_subscribe	ログ.サブスクライブ
AdminLog_subscriptions	ログ.サブスクリプション
AdminLog_購読解除	ログ.購読解除
Allocator_bytesAllocated	allocator.bytesAllocated
アロケータ_スナップショット	アロケータ.スナップショット
AuthorizedPasswords_add	認可されたパスワード.追加
認可されたパスワードのリスト	許可されたパスワード.リスト
AuthorizedPasswords_remove	認可されたパスワード.削除
コア出口	コア.終了
Core_initTunnel	core.initTunnel
コアピッド	コア.pid
InterfaceController_disconnectPeer	InterfaceController.disconnectPeer
InterfaceController_peerStats	InterfaceController.peerStats
	InterfaceController.peerStatsPages
IpTunnel_allowConnection	ipTunnel.allowConnection
IpTunnel_connectTo	ipTunnel.connectTo
IpTunnel_listConnections	ipTunnel.listConnections
IpTunnel_removeConnection	ipTunnel.removeConnection
IpTunnel_showConnection	ipTunnel.showConnection
Janitor_dumpRumorMill	管理人.dumpRumorMill
メモリ	管理者メモリ
	nodeStore.dumpTablePages
ノードストア_getLink	ノードストア.getLink
NodeStore_getRouteLabel	ノードストア.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	検索ランナー.検索
Security_check権限	security.checkPermissions
Security_chroot	security.chroot
Security_getUser	security.getUser
Security_nofiles	security.nofiles
Security_noforks	security.noforks
セキュリティ_seccomp	セキュリティ.seccomp
Security_setupComplete	security.setupComplete
Security_setUser	security.setUser
SessionManager_getHandles	sessionManager.getHandles
	sessionManager.getHandlesPages
SessionManager_sessionStats	sessionManager.sessionStats
SwitchPinger_ping	switchPinger.ping
UDPInterface_beginConnection	udpInterface.beginConnection
UDPインターフェース_新規	udpInterface.new

Admin_asyncEnabled、admin.asyncEnabled

使用法：

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

Admin_availableFunctions、admin.availableFunctions

• ページ、int、オプション

使用法：

 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_bytesAllocated、allocator.bytesAllocated

使用法：

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

アロケータ_スナップショット、アロケータ.スナップショット

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

コア出口、コア出口

使用法：

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

Core_initTunnel、core.initTunnel

• 望ましいTunName、文字列、オプション

使用法：

 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

• ページ、int、オプション

使用法：

 var channel ,
    options ;

options = {
    page : 0
} ;

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

IpTunnel_allowConnection、ipTunnel.allowConnection

• ip4Address、文字列、オプション
• ip4Prefix、int、オプション
• ip6Address、文字列、オプション
• ip6Prefix、int、オプション
• 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

• 接続、int、必須

使用法：

 var channel ,
    options ;

options = {
    connection : 0
} ;

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

IpTunnel_showConnection、ipTunnel.showConnection

• 接続、int、必須

使用法：

 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、admin.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

• NearPath、文字列、オプション
• パス、文字列、必須
• タイムアウト、整数、オプション

使用法：

 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、int、オプション

使用法：

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

Security_chroot、security.chroot

• ルート、文字列、必須

使用法：

 var channel ,
    options ;

options = {
    root : ''
} ;

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

Security_getUser、security.getUser

• ユーザー、文字列、オプション

使用法：

 var channel ,
    options ;

options = {
    user : ''
} ;

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

Security_nofiles、security.nofiles

使用法：

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

Security_noforks、security.noforks

使用法：

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

Security_seccomp、security.seccomp

使用法：

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

Security_setupComplete、security.setupComplete

使用法：

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

Security_setUser、security.setUser

• keepNetAdmin、int、必須
• uid、int、必須

使用法：

 var channel ,
    options ;

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

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

SessionManager_getHandles、sessionManager.getHandles

• ページ、int、オプション

使用法：

 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、int、オプション
• パス、文字列、必須
• タイムアウト、整数、オプション

使用法：

 var channel ,
    options ;

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

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

UDPInterface_beginConnection、udpInterface.beginConnection

• アドレス、文字列、必須
• インターフェース番号、整数、オプション
• パスワード、文字列、オプション
• publicKey、文字列、必須

使用法：

 var channel ,
    options ;

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

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

UDPInterface_new、udpInterface.new

• bindAddress、文字列、オプション

使用法：

 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