Espruino:Справочник по API/Класс NRF/setSecurity(): различия между версиями

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
(Новая страница: «{{Espruino/Панель перехода}} {{Перевод от Сubewriter}} {{Myagkij-редактор}} =<ref>[ www.espruino.com - ]</ref>= ==Синтакс...»)
 
Нет описания правки
Строка 3: Строка 3:
{{Myagkij-редактор}}
{{Myagkij-редактор}}


=<ref>[ www.espruino.com - ]</ref>=
=Функция NRF.setSecurity()<ref>[https://www.espruino.com/Reference#t_l_NRF_setSecurity www.espruino.com - NRF.setSecurity]</ref>=


==Синтаксис==
==Синтаксис==


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript" enclose="div">
 
NRF.setSecurity(options)
</syntaxhighlight>
</syntaxhighlight>


==Параметры==
==Параметры==


 
* '''options''' – объект, содержащий настройки безопасности (см. ниже)


==Возвращаемое значение==
==Возвращаемое значение==
Строка 21: Строка 21:
==Описание==
==Описание==


Задает настройки безопасности, которые используются при подключении/сопряжении. Они применяются и в режиме центрального, и в режиме периферийного устройства.
<syntaxhighlight lang="javascript" enclose="div">
NRF.setSecurity({
  display : bool  // здесь задается, будет ли пароль,
                  // отправленный в событии `BluetoothDevice.passkey`
                  // показан на дисплее устройства
                  // (значение по умолчанию – «false»)
  keyboard : bool // здесь задается, можно ли на этом устройстве
                  // ввести пароль, запрошенный с помощью события
                  // `BluetoothDevice.passkeyRequest`
                  // (значение по умолчанию – «false»)
  bond : bool // выполнять ли сопряжение (по умолчанию «true»)
  mitm : bool // защиты от атаки посредника (по умолчанию «false»)
  lesc : bool // используется ли LE Secure Connections
              // (по умолчанию «false»)
  passkey :  // 6-циферный пароль (по умолчанию "")
  oob : [0..15] // если эта настройка будет задана, это включит
                // внеполосное (out-of-band или OOB) сопряжение,     
                // где будет использован заданный здесь 16-байтный код
});
</syntaxhighlight>
'''Примечание:''' Некоторые комбинации аргументов могут выдать ошибку. Например, нельзя задать пароль и при этом не задать display:1. Настройку display:1 можно задать и не имея, собственно, самого дисплея – пользователю просто нужно знать ваш пароль.
Например, запросить сопряжение и задать пароль можно вот так:
<syntaxhighlight lang="javascript" enclose="div">
NRF.setSecurity({passkey:"123456", mitm:1, display:1});
</syntaxhighlight>
Хотя большинство устройств на этом этапе запрашивают пароль для сопряжения, вы по-прежнему можете подключиться к устройству и без него (например, при помощи приложения nRF Connect).
С помощью пароля можно защитить все характеристики, заданные с помощью функции NRF.setServices(). Например, код ниже потребует ввести пароль 123456 перед чтением характеристики 9d020002-bf5f-1d1a-b52a-fe52091d5b12.
<syntaxhighlight lang="javascript" enclose="div">
NRF.setSecurity({passkey:"123456", mitm:1, display:1});
NRF.setServices({
  "9d020001-bf5f-1d1a-b52a-fe52091d5b12" : {
    "9d020002-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть всегда:
      value : "Не секрет"
    },
    "9d020003-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть только после сопряжения:
      value : "Секрет",
      readable : true,
      security: {
        read: {
          mitm: true,
          encrypted: true
        }
      }
    },
    "9d020004-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть всегда,
      // записать можно только после сопряжения:
      value : "Можно прочесть",
      readable : true,
      writable : true,
      onWrite : function(evt) {
        console.log("Данные записаны ", evt.data);
      },
      security: {
        write: {
          mitm: true,
          encrypted: true
        }
      }
    }
  }
});
</syntaxhighlight>
'''Примечание:''' Если заданы настройки passkey и oob, в сервисе Nordic UART (если он включен) будет автоматически включено шифрование. В противном случае он будет открыт.


'''Примечание:''' Эта функция доступна только для NRF52-устройств (вроде Puck.js, Pixl.js, Bangle.js и MDBT42Q).


== Примеры ==
== Примеры ==

Версия от 17:30, 7 февраля 2021

Перевод: Максим Кузьмин
Проверка/Оформление/Редактирование: Мякишев Е.А.


Функция NRF.setSecurity()[1]

Синтаксис

NRF.setSecurity(options)

Параметры

  • options – объект, содержащий настройки безопасности (см. ниже)

Возвращаемое значение

Описание

Задает настройки безопасности, которые используются при подключении/сопряжении. Они применяются и в режиме центрального, и в режиме периферийного устройства. 

NRF.setSecurity({
  display : bool  // здесь задается, будет ли пароль,
                  // отправленный в событии `BluetoothDevice.passkey`
                  // показан на дисплее устройства
                  // (значение по умолчанию – «false»)
  keyboard : bool // здесь задается, можно ли на этом устройстве
                  // ввести пароль, запрошенный с помощью события
                  // `BluetoothDevice.passkeyRequest`
                  // (значение по умолчанию – «false»)
  bond : bool // выполнять ли сопряжение (по умолчанию «true»)
  mitm : bool // защиты от атаки посредника (по умолчанию «false») 
  lesc : bool // используется ли LE Secure Connections
              // (по умолчанию «false»)
  passkey :   // 6-циферный пароль (по умолчанию "")
  oob : [0..15] // если эта настройка будет задана, это включит
                // внеполосное (out-of-band или OOB) сопряжение,      
                // где будет использован заданный здесь 16-байтный код
});

Примечание: Некоторые комбинации аргументов могут выдать ошибку. Например, нельзя задать пароль и при этом не задать display:1. Настройку display:1 можно задать и не имея, собственно, самого дисплея – пользователю просто нужно знать ваш пароль.

Например, запросить сопряжение и задать пароль можно вот так: 

NRF.setSecurity({passkey:"123456", mitm:1, display:1});

Хотя большинство устройств на этом этапе запрашивают пароль для сопряжения, вы по-прежнему можете подключиться к устройству и без него (например, при помощи приложения nRF Connect).

С помощью пароля можно защитить все характеристики, заданные с помощью функции NRF.setServices(). Например, код ниже потребует ввести пароль 123456 перед чтением характеристики 9d020002-bf5f-1d1a-b52a-fe52091d5b12. 

NRF.setSecurity({passkey:"123456", mitm:1, display:1});
NRF.setServices({
  "9d020001-bf5f-1d1a-b52a-fe52091d5b12" : {
    "9d020002-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть всегда:
      value : "Не секрет"
    },
    "9d020003-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть только после сопряжения:
      value : "Секрет",
      readable : true,
      security: {
        read: {
          mitm: true,
          encrypted: true
        }
      }
    },
    "9d020004-bf5f-1d1a-b52a-fe52091d5b12" : {
      // можно прочесть всегда,
      // записать можно только после сопряжения:
      value : "Можно прочесть",
      readable : true,
      writable : true,
      onWrite : function(evt) {
        console.log("Данные записаны ", evt.data);
      },
      security: {
        write: {
          mitm: true,
          encrypted: true
        }
      }
    }
  }
});

Примечание: Если заданы настройки passkey и oob, в сервисе Nordic UART (если он включен) будет автоматически включено шифрование. В противном случае он будет открыт.

Примечание: Эта функция доступна только для NRF52-устройств (вроде Puck.js, Pixl.js, Bangle.js и MDBT42Q).

Примеры

См.также

Партнерские ресурсы
Криптовалюты
Магазины
Хостинг
Разное

Внешние ссылки

  1. ↑ www.espruino.com - NRF.setSecurity
Справочник по API Espruino
Глобальные методы, переменные и объекты • acceleration() • analogRead() • analogWrite() • arguments • atob() • Объект Bluetooth • btoa() • changeInterval() • clearInterval() • clearTimeout() • clearWatch() • compass() • decodeURIComponent() • digitalPulse() • digitalRead() • digitalWrite() • dump() • echo() • edit() • encodeURIComponent() • eval() • FET • getPinMode() • getSerial() • getTime() • global • HIGH • Объект I2C1 • Объект I2C2 • Объект I2C3 • Infinity • isFinite() • isNaN() • load() • Объект LoopBackA • Объект LoopBackB • LOW • NaN • parseFloat() • parseInt() • peek16() • peek32() • peek8() • pinMode() • poke16() • poke32() • poke8() • print() • require() • reset() • save() • SCL • SDA • Объект Serial1 • Объект Serial2 • Объект Serial3 • Объект Serial4 • Объект Serial5 • Объект Serial6 • setBusyIndicator() • setDeepSleep() • setInterval() • setSleepIndicator() • setTime() • setTimeout() • setWatch() • shiftOut() • show() • Объект SPI1 • Объект SPI2 • Объект SPI3 • Объект Telnet • Объект Terminal • trace() • Объект USB • VIBRATE
Класс AES • decrypt() • encrypt()
Класс Array • Array() • concat() • every() • fill() • filter() • find() • findIndex() • forEach() • includes() • indexOf() • isArray() • join() • length • map() • pop() • push() • reduce() • reverse() • shift() • slice() • some() • sort() • splice() • toString() • unshift()
Класс ArrayBuffer • ArrayBuffer() • byteLength
Класс ArrayBufferView • buffer • byteLength • byteOffset • fill() • filter() • find() • findIndex() • forEach() • includes() • indexOf() • join() • map() • reduce() • reverse() • set() • slice() • sort()
Класс Bangle • accel • accelRd() • accelWr() • aiGesture • beep() • buzz() • charging • compassWr() • dbg() • drawWidgets() • F_BEEPSET • faceUp • gesture • getAccel() • getCompass() • getLCDMode() • getLogo() • GPS • GPS-raw • HRM • ioWr() • isCharging() • isLCDOn() • lcdPower • lcdWr() • loadWidgets() • mag • off() • project() • setCompassPower() • setGPSPower() • setHRMPower() • setLCDBrightness() • setLCDMode() • setLCDOffset() • setLCDPower() • setLCDTimeout() • setOptions() • setPollInterval() • showLauncher() • step • swipe • touch • twist
Класс BluetoothDevice • connected • gatt • gattserverdisconnected • passkey • passkeyRequest • rssi • sendPasskey()
Класс BluetoothRemoteGATTCharacteristic • characteristicvaluechanged • readValue() • startNotifications() • stopNotifications() • writeValue()
Класс BluetoothRemoteGATTServer • connect() • disconnect() • getPrimaryService() • getPrimaryServices() • getSecurityStatus() • setRSSIHandler() • startBonding()
Класс BluetoothRemoteGATTService • getCharacteristic() • getCharacteristics()
Класс Boolean • Boolean()
Библиотека CC3000 • connect()
Класс Console • log()
Библиотека crypto • AES • PBKDF2() • SHA1() • SHA224() • SHA256() • SHA384() • SHA512()
Класс DataView • DavaView() • getFloat32() • getFloat64() • getInt16() • getInt32() • getInt8() • getUint16() • getUint32() • getUint8() • setFloat32() • setFloat64() • setInt16() • setInt32() • setInt8() • setUint16() • setUint32() • setUint8()
Класс Date • Date() • getDate() • getDay() • getFullYear() • getHours() • getMilliseconds() • getMinutes() • getMonth() • getSeconds() • getTime() • getTimezoneOffset() • now() • parse() • setDate() • setFullYear() • setHours() • setMilliseconds() • setMinutes() • setMonth() • setSeconds() • setTime() • toISOString() • toJSON() • toString() • toUTCString() • valueOf()
Библиотека dgram • createSocket()
Класс dgramSocket • addMembership() • bind() • Функция close() • Событие close() • message • send()
Класс E • asm() • clip() • compiledC() • connectSDCard() • convolve() • CRC32() • defrag() • dumpFragmentation() • dumpFreeList() • dumpLockedVars() • dumpStr() • dumpTimers() • dumpVariables() • enableWatchdog() • errorFlag • FFT() • flashFatFS() • getAddressOf() • getAnalogVRef() • getBattery() • getConsole() • getErrorFlags() • getFlags() • getRTCPrescaler() • getSizeOf() • getTemperature() • HSBtoRGB() • hwRand() • init • kickWatchdog() • kill • lockConsole() • lookupNoCase() • mapInPlace() • memoryArea() • memoryMap() • nativeCall() • openFile() • pipe() • reboot() • reverseByte() • sendUSBHID() • setBootCode() • setClock() • setConsole() • setFlags() • setPassword() • setRTCPrescaler() • setTimeZone() • setUSBHID() • showAlert() • showMenu() • showMessage() • showPrompt() • srand() • sum() • toArrayBuffer() • toJS() • toString() • toUint8Array() • unmountSD() • variance()
Класс Error • Error() • toString()
Библиотека ESP8266 • crc32() • deepSleep() • dumpSocketInfo() • getFreeFlash() • getResetInfo() • getState() • logDebug() • neopixelWrite() • ping() • printLog() • readLog() • reboot() • setCPUFreq() • setLog()
Класс Ethernet • getHostname() • getIP() • getStatus() • setHostname() • setIP()
Класс File • close() • pipe() • read() • seek() • skip() • write()
Библиотека Flash • erasePage() • getFree() • getPage() • read() • write()
Класс Float32Array • Float32Array()
Класс Float64Array • Float64Array()
Библиотека fs • appendFile() • appendFileSync() • mkdir() • mkdirSync() • pipe() • readdir() • readdirSync() • readFile() • readFileSync() • statSync() • unlink() • unlinkSync() • writeFile() • writeFileSync()
Класс Function • apply() • bind() • call() • Function() • replaceWith()
Класс Graphics • asBMP() • asImage() • asURL() • buffer • clear() • clearRect() • createArrayBuffer() • createCallback() • createImage() • createSDL() • drawCircle() • drawEllipse() • drawImage() • drawImages() • drawLine() • drawLineAA() • drawPoly() • drawPolyAA() • drawRect() • drawString() • dump() • fillCircle() • fillEllipse() • fillPoly() • fillRect() • flip() • getBgColor() • getColor() • getFont() • getFontHeight() • getFonts() • getHeight() • getInstance() • getModified() • getPixel() • getWidth() • lineTo() • moveTo() • quadraticBezier() • reset() • scroll() • setBgColor() • setClipRect() • setColor() • setFont() • setFontAlign() • setFontBitmap() • setFontCustom() • setFontVector() • setPixel() • setRotation() • stringWidth() • toColor() • transformVertices()
Библиотека heatshrink • compress() • decompress()
Библиотека http • createServer() • get() • request()
Класс httpCRq • drain • end() • error • write()
Класс httpCRs • available() • close • data • error • headers • httpVersion • pipe() • read() • statusCode • statusMessage
Класс httpSRq • available() • close • data • headers • method • pipe() • read() • url
Класс httpSRs • close • drain • end() • headers • setHeader() • write() • writeHead()
Класс httpSrv • close() • listen()
Класс I2C • find() • I2C() • readFrom() • setup() • writeTo()
Класс Int16Array • Int16Array()
Класс Int32Array • Int32Array()
Класс Int8Array • Int8Array()
Класс InternalError • InternalError() • toString()
Класс JSON • parse() • stringify()
Класс Math • abs() • acos() • asin() • atan() • atan2() • ceil() • clip() • cos() • E • exp() • floor() • LN10 • LN2 • log() • LOG10E • LOG2E • max() • min() • PI • pow() • random() • round() • sin() • sqrt() • SQRT1_2 • SQRT2 • tan() • wrap()
Класс Microbit • accel() • accelOff() • accelOn() • accelWr() • gesture • mag() • MIC • MIC_ENABLE • play() • record() • SPEAKER
Класс Modules • addCached() • getCached() • removeAllCached() • removeCached()
Библиотека neopixel • write()
Библиотека net • connect() • createServer()
Библиотека NetworkJS • create()
Класс NodeMCU • A0 • D0 • D1 • D2 • D3 • D4 • D5 • D6 • D7 • D8 • D9 • D10
Класс NRF • characteristicsDiscover • connect • connect() • disconnect • disconnect() • filterDevices() • findDevices() • getAddress() • getAdvertisingData() • getBattery() • getSecurityStatus() • HID • nfcAndroidApp() • NFCoff • NFCon • nfcPair() • nfcRaw() • NFCrx • nfcSend() • nfcStart() • nfcStop() • nfcURL() • requestDevice() • restart() • security • sendHIDReport() • servicesDiscover • setAddress() • setAdvertising() • setConnectionInterval() • setLowPowerConnection() • setRSSIHandler() • setScan() • setScanResponse() • setSecurity() • setServices() • setTxPower() • setWhitelist() • sleep() • updateServices() • wake()
Класс Nucleo • A0 • A1 • A2 • A3 • A4 • A5 • D0 • D1 • D2 • D3 • D4 • D5 • D6 • D7 • D8 • D9 • D10 • D11 • D12 • D13 • D14 • D15
Класс Number • MAX_VALUE • MIN_VALUE • NaN • NEGATIVE_INFINITY • Number() • POSITIVE_INFINITY • toFixed()
Класс Object • assign() • clone() • create() • defineProperties() • defineProperty() • emit() • getOwnPropertyDescriptor() • getOwnPropertyNames() • getPrototypeOf() • hasOwnProperty() • keys() • length • Object() • on() • removeAllListeners() • removeListener() • setPrototypeOf() • toString() • valueOf()
Класс OneWire • OneWire() • read() • reset() • search() • select() • skip() • write()
Класс Pin • getInfo() • getMode() • mode() • Pin() • read() • reset() • set() • toggle() • write() • writeAtTime()
Класс Pixl • getBatteryPercentage() • lcdw() • menu() • setContrast() • setLCDPower()
Класс process • env • memory() • uncaughtException • version
Класс Promise • all() • catch() • Promise() • reject() • resolve() • then()
Класс Puck • accel • accel() • accelOff() • accelOn() • accelRd() • accelWr() • capSense() • getBatteryPercentage() • getTemperature() • IR() • light() • mag() • mag • magOff() • magOn() • magRd() • magTemp() • magWr() • selfTest()
Класс ReferenceError • ReferenceError() • toString()
Класс RegExp • exec() • RegExp() • test()
Класс Serial • available() • data • find() • framing • inject() • parity • pipe() • print() • println() • read() • Serial() • setConsole() • setup() • unsetup() • write()
Класс Server • close() • listen()
Класс Socket • available() • close • data • drain • end() • error • pipe() • read() • write()
Класс SPI • find() • send() • send4bit() • send8bit() • setup() • SPI() • write()
Библиотека Storage • compact() • debug() • erase() • eraseAll() • getFree() • list() • open() • read() • readArrayBuffer() • readJSON() • write() • writeJSON()
Класс StorageFile • erase() • getLength() • read() • readLine() • write()
Класс String • charAt() • charCodeAt() • endsWith() • fromCharCode() • includes() • indexOf() • lastIndexOf() • length • match() • padEnd() • padStart() • repeat() • replace() • slice() • split() • startsWith() • String() • substr() • substring() • toLowerCase() • toUpperCase() • trim()
Класс SyntaxError • SyntaxError() • toString()
Библиотека TelnetServer • setOptions()
Библиотека tensorflow • create()
Класс TFMicroInterpreter • getInput() • getOutput() • invoke()
Библиотека tls • connect()
Библиотека tv • setup()
Класс TypeError • toString() • TypeError()
Класс Uint16Array • Uint16Array()
Класс Uint24Array • Uint24Array()
Класс Uint32Array • Uint32Array()
Класс Uint8Array • Uint8Array()
Класс Uint8ClampedArray • Uint8ClampedArray()
Класс url • parse()
Класс Waveform • startInput() • startOutput() • stop() • Waveform()
Библиотека WiFi • associated • auth_change • connect() • connected • dhcp_timeout • disconnect() • disconnected • getAPDetails() • getAPIP() • getDetails() • getHostByName() • getHostname() • getIP() • getStatus() • ping() • probe_recv • restore() • save() • scan() • setAPIP() • setConfig() • setIP() • setSNTP() • sta_joined • sta_left • startAP() • stopAP() • turbo()
Класс WioLTE • A4 • A6 • D20 • D38 • I2C • LED() • setGrovePower() • setLEDPower() • UART
Библиотека WIZnet • connect()
Класс WLAN • connect() • disconnect() • getIP() • reconnect() • setIP()

Источник — http://wikihandbk.com/ruwiki/index.php?title=Espruino:Справочник_по_API/Класс_NRF/setSecurity()&oldid=1794669