تنزيل cjdns admin - تنزيل كود مصدر cjdns admin

️ تعد CJDNS تقنية جيدة ولكن معظم الأشخاص المحيطين بها هم مجموعة من حثالة الشيوعية غير المتسامحين والعدائيين. إذا كنت تريد تولي هذه الوحدة والتعامل مع هؤلاء الأشخاص، فيرجى إعدادها وإصدارها وسنعمل على حلها. شكرًا لك

cjdns-admin

وحدة Nodejs للعمل مع واجهة إدارة CJDNS عبر UDP. لقد تم تصميمها لتكون متسقة وقوية وسهلة الاستخدام.

القفز:

إنشاء كائن المسؤول
وظائف إدارة CJDNS
وظائف مقسمة إلى صفحات
تطوير

ثَبَّتَ

إنه متاح عبر npm

 npm install cjdns-admin

منشئ createAdmin

تقوم الدالة createAdmin بإرجاع EventEmitter4 مع أعضاء لكل وظيفة إدارية وبديلهم. ويحتوي أيضًا على أعضاء يتعاملون مع الترحيل التلقائي للوظائف التي يتم ترحيلها.

خيارات:

الملكية الفكرية، سلسلة، اختياري
المنفذ، الرقم، اختياري
كلمة المرور، سلسلة، مطلوبة

الاستخدام:

 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_subscribe	سجل.الاشتراك
AdminLog_subscriptions	سجل الاشتراكات
AdminLog_unsubscribe	سجل.إلغاء الاشتراك
Allocator_bytesAllocated	allocator.bytesAllocated
تخصيص_لقطة	allocator.snapshot
AuthorizedPasswords_add	AuthorizedPasswords.add
AuthorizedPasswords_list	AuthorizedPasswords.list
AuthorizedPasswords_remove	AuthorizedPasswords.remove
Core_exit	core.exit
Core_initTunnel	core.initTunnel
Core_pid	core.pid
InterfaceController_disconnectPeer	واجهةController.disconnectPeer
InterfaceController_peerStats	واجهةController.peerStats
	واجهةController.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
ذاكرة	admin.memory
	NodeStore.dumpTablePaged
NodeStore_getLink	nodeStore.getLink
NodeStore_getRouteLabel	NodeStore.getRouteLabel
NodeStore_nodeForAddr	nodeStore.nodeForAddr
بينغ	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	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.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، سجل.الاشتراك

ملف، سلسلة، اختياري
المستوى، سلسلة، اختياري
الخط، كثافة العمليات، اختياري

الاستخدام:

 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

معرف الدفق، السلسلة، مطلوب

الاستخدام:

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

Allocator_snapshot، allocator.snapshot

تشمل المخصصات، كثافة العمليات، اختياري

الاستخدام:

 var channel ,
    options ;

options = {
    includeAllocations : 0
} ;

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

AuthorizedPasswords_add، AuthorizedPasswords.add

نوع المصادقة، كثافة العمليات، اختياري
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

المطلوب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

pubkey، سلسلة، مطلوبة

الاستخدام:

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

الذاكرة، admin.memory

الاستخدام:

 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

رقم الرابط، 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

الملكية الفكرية، سلسلة، اختياري

الاستخدام:

 var channel ,
    options ;

options = {
    ip : ''
} ;

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

بينغ، 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، سلسلة، مطلوبة
طلبات ماكس، كثافة العمليات، اختياري

الاستخدام:

 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، مطلوب
معرف المستخدم، كثافة العمليات، المطلوبة

الاستخدام:

 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

العنوان، السلسلة، المطلوبة
رقم الواجهة، كثافة العمليات، اختياري
كلمة المرور، سلسلة، اختياري
المفتاح العام، سلسلة، مطلوب

الاستخدام:

 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. راجع package.json في قسم 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

يوسع