nl::Weave::โปรไฟล์::ความปลอดภัย::รหัสผ่าน

เนมสเปซนี้รวมอินเทอร์เฟซทั้งหมดภายใน Weave สําหรับไลบรารีรหัสผ่าน Weave ภายในโปรไฟล์การรักษาความปลอดภัย Weave

สรุป

การแจกแจง
@278{
  kPasscode_Config1_TEST_ONLY = 0x01,
  kPasscode_Config2 = 0x02,
  kPasscodeConfig1_KeyId = WeaveKeyId::kNone
} 		enum
สานประเภทการกําหนดค่าการเข้ารหัสรหัสผ่าน
@279{
  kPasscodeEncryptionKeyLen = Platform::Security::AES128BlockCipher::kKeyLength,
  kPasscodeAuthenticationKeyLen = Platform::Security::SHA1::kHashLength,
  kPasscodeFingerprintKeyLen = Platform::Security::SHA1::kHashLength,
  kPasscodeTotalDerivedKeyLen = kPasscodeEncryptionKeyLen + kPasscodeAuthenticationKeyLen,
  kPasscodePaddedLen = Platform::Security::AES128BlockCipher::kBlockLength,
  kPasscodeAuthenticatorLen = 8,
  kPasscodeFingerprintLen = 8,
  kPasscodeMaxEncryptedLen = sizeof(uint8_t) + 2 * sizeof(uint32_t) + kPasscodePaddedLen + kPasscodeAuthenticatorLen + kPasscodeFingerprintLen,
  kPasscodeMaxLen = kPasscodePaddedLen,
  kPasscodeEncKeyDiversifierSize = sizeof(kPasscodeEncKeyDiversifier) + sizeof(uint8_t),
  kPasscodeFingerprintKeyDiversifierSize = sizeof(kPasscodeFingerprintKeyDiversifier)
} 		enum
แก้ไขขนาดพารามิเตอร์ของโปรโตคอลการเข้ารหัสรหัสผ่าน

ตัวแปร
kPasscodeEncKeyDiversifier = { 0x1A, 0x65, 0x5D, 0x96 }[]
const uint8_t
เครื่องมือเปลี่ยนคีย์ที่ใช้สําหรับการรับคีย์การเข้ารหัสของรหัสผ่าน Weave
kPasscodeFingerprintKeyDiversifier = { 0xD1, 0xA1, 0xD9, 0x6C }[]
const uint8_t
เครื่องมือเปลี่ยนคีย์ที่ใช้สําหรับการรับคีย์การเข้ารหัสของรหัสผ่าน Weave

ฟังก์ชัน
DecryptPasscode(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t *passcodeBuf, size_t passcodeBufSize, size_t & passcodeLen, GroupKeyStoreBase *groupKeyStore)
ถอดรหัสรหัสผ่านที่เข้ารหัสโดยใช้รูปแบบการเข้ารหัสของ Nest Passcode
DecryptPasscode(const uint8_t *encPasscode, size_t encPasscodeLen, const uint8_t *encKey, const uint8_t *authKey, const uint8_t *fingerprintKey, uint8_t *passcodeBuf, size_t passcodeBufSize, size_t & passcodeLen)
ถอดรหัสรหัสผ่านที่เข้ารหัสโดยใช้รูปแบบการเข้ารหัสของ Nest Passcode
EncryptPasscode(uint8_t config, uint32_t keyId, uint32_t nonce, const uint8_t *passcode, size_t passcodeLen, uint8_t *encPasscode, size_t encPasscodeBufSize, size_t & encPasscodeLen, GroupKeyStoreBase *groupKeyStore)
เข้ารหัสรหัสผ่านโดยใช้รูปแบบการเข้ารหัสรหัสผ่าน Nest
EncryptPasscode(uint8_t config, uint32_t keyId, uint32_t nonce, const uint8_t *passcode, size_t passcodeLen, const uint8_t *encKey, const uint8_t *authKey, const uint8_t *fingerprintKey, uint8_t *encPasscode, size_t encPasscodeBufSize, size_t & encPasscodeLen)
เข้ารหัสรหัสผ่านโดยใช้รูปแบบการเข้ารหัสรหัสผ่าน Nest
GetEncryptedPasscodeConfig(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t & config)
รับประเภทการกําหนดค่าของรหัสผ่านที่เข้ารหัส
GetEncryptedPasscodeFingerprint(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t *fingerprintBuf, size_t fingerprintBufSize, size_t & fingerprintLen)
รับค่าลายนิ้วมือที่เชื่อมโยงกับรหัสผ่านที่เข้ารหัส
GetEncryptedPasscodeKeyId(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & keyId)
รับรหัสของรหัสที่ใช้เข้ารหัสรหัสผ่านที่เข้ารหัส
GetEncryptedPasscodeNonce(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & nonce)
รับค่า cece ที่เชื่อมโยงกับรหัสผ่านที่เข้ารหัส
IsSupportedPasscodeEncryptionConfig(uint8_t config)
bool
ส่งคืนค่า True หาก API การเข้ารหัส/การถอดรหัสรหัสผ่านรองรับการกําหนดค่าการเข้ารหัสรหัสผ่านที่ระบุ

โครงสร้าง
nl::Weave::Profiles::Security::Passcodes::EncryptedPasscodeStruct

การแจกแจง

278

 @278

สานประเภทการกําหนดค่าการเข้ารหัสรหัสผ่าน

พร็อพเพอร์ตี้
kPasscodeConfig1_KeyId

รหัสคีย์จําลองที่ใช้สําหรับการกําหนดค่ารหัสผ่านทดสอบ #1

kPasscode_Config1_TEST_ONLY

การกําหนดค่าการเข้ารหัสรหัสผ่านที่ 1 ไม่ได้ใช้การเข้ารหัสและคีย์ลับในการตรวจสอบสิทธิ์และรหัสผ่านของลายนิ้วมือ

การกําหนดค่านี้ควรใช้เพื่อการทดสอบเท่านั้น

kPasscode_Config2

การกําหนดค่าการเข้ารหัสรหัสผ่าน #2 ใช้การเข้ารหัส AES-128-ECB ที่มีความสมบูรณ์ของ HMAC-SHA-1 8 ไบต์และลายนิ้วมือ HMAC-SHA-1 8 ไบต์

279

 @279

แก้ไขขนาดพารามิเตอร์ของโปรโตคอลการเข้ารหัสรหัสผ่าน

พร็อพเพอร์ตี้
kPasscodeAuthenticationKeyLen

ความยาวของคีย์การตรวจสอบสิทธิ์รหัสผ่าน (SHA-1)

kPasscodeAuthenticatorLen

ความยาวของ Authenticator ของรหัสผ่าน

kPasscodeEncKeyDiversifierSize

ขนาดเครื่องมือสร้างคีย์คีย์การเข้ารหัสรหัสผ่าน

kPasscodeEncryptionKeyLen

ความยาวของการเข้ารหัสรหัสผ่าน (AES-128)

kPasscodeFingerprintKeyDiversifierSize

ขนาดของโปรแกรมสํารวจคีย์ลายนิ้วมือสําหรับรหัสผ่าน

kPasscodeFingerprintKeyLen

ความยาวของคีย์รหัสผ่าน (SHA-1) ของรหัสผ่าน

kPasscodeFingerprintLen

ความยาวของลายนิ้วมือสําหรับรหัสผ่าน

kPasscodeMaxEncryptedLen

ความยาวสูงสุดของรหัสผ่านที่เข้ารหัส

kPasscodeMaxLen

ความยาวสูงสุดของรหัสผ่านที่ไม่เข้ารหัส

kPasscodePaddedLen

ความยาวของรหัสผ่าน (เสริมด้วยความยาวบล็อก AES-128)

kPasscodeTotalDerivedKeyLen

ความยาวของคีย์รวม (การเข้ารหัสและ AMP และความสมบูรณ์)

ตัวแปร

คีย์ kPasscodeEncKeyDiversifier

const uint8_t kPasscodeEncKeyDiversifier[] = { 0x1A, 0x65, 0x5D, 0x96 }

เครื่องมือเปลี่ยนคีย์ที่ใช้สําหรับการรับคีย์การเข้ารหัสของรหัสผ่าน Weave

ค่านี้แสดงถึง 4 ไบต์แรกของ SHA-1 HASH ของ "Nest Passcode EK และ AK"

คีย์ตัวแยกลายนิ้วมือ kPasscode

const uint8_t kPasscodeFingerprintKeyDiversifier[] = { 0xD1, 0xA1, 0xD9, 0x6C }

เครื่องมือเปลี่ยนคีย์ที่ใช้สําหรับการรับคีย์การเข้ารหัสของรหัสผ่าน Weave

ค่านี้แสดงถึง 4 ไบต์แรกของ SHA-1 HASH ของ "Nest Passcode EK และ AK"

ฟังก์ชัน

ถอดรหัสรหัสผ่าน

WEAVE_ERROR DecryptPasscode(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t *passcodeBuf,
  size_t passcodeBufSize,
  size_t & passcodeLen,
  GroupKeyStoreBase *groupKeyStore
)

ถอดรหัสรหัสผ่านที่เข้ารหัสโดยใช้รูปแบบการเข้ารหัสของ Nest Passcode

รายละเอียด
พารามิเตอร์
[in] encPasscode
ตัวชี้ไปยังบัฟเฟอร์รหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[in] passcodeBuf
ตัวชี้ไปยังบัฟเฟอร์เพื่อรับรหัสผ่านที่ถอดรหัสแล้ว
[in] passcodeBufSize
ขนาดของบัฟเฟอร์ที่ชี้ไปยังโดย PasswordBuf
[out] passcodeLen
ตั้งความยาวของรหัสผ่านที่เข้ารหัส
[in] groupKeyStore
ตัวชี้ไปยังออบเจ็กต์ที่เก็บคีย์ของกลุ่ม
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG
หากระบบไม่รองรับการกําหนดค่ารหัสผ่านที่ระบุ
WEAVE_ERROR_PASSCODE_AUTHENTICATION_FAILED
หากตรวจสอบสิทธิ์รหัสผ่านไม่สําเร็จ
WEAVE_ERROR_PASSCODE_FINGERPRINT_FAILED
หากการตรวจสอบลายนิ้วมือของรหัสผ่านล้มเหลว
WEAVE_ERROR_INVALID_KEY_ID
หากคีย์ที่ขอมีรหัสคีย์ที่ไม่ถูกต้อง
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์รหัสผ่านที่ระบุมีขนาดเล็กเกินไป
WEAVE_ERROR_INVALID_ARGUMENT
หากรหัสผ่านที่เข้ารหัสสั้นหรือสั้นเกินไป หรือหากไม่ได้ระบุตัวชี้ไปยังคีย์สโตร์ของกลุ่ม หรือที่เก็บคีย์ของแพลตฟอร์มแสดงผลพารามิเตอร์คีย์ที่ไม่ถูกต้อง
other
ข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่แสดงผลโดย API ที่เก็บข้อมูลคีย์ของแพลตฟอร์ม

ถอดรหัสรหัสผ่าน

WEAVE_ERROR DecryptPasscode(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  const uint8_t *encKey,
  const uint8_t *authKey,
  const uint8_t *fingerprintKey,
  uint8_t *passcodeBuf,
  size_t passcodeBufSize,
  size_t & passcodeLen
)

ถอดรหัสรหัสผ่านที่เข้ารหัสโดยใช้รูปแบบการเข้ารหัสของ Nest Passcode

รายละเอียด
พารามิเตอร์
[in] encPasscode
ตัวชี้ไปยังบัฟเฟอร์รหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[in] encKey
ตัวชี้ไปยังคีย์ที่จะใช้เข้ารหัสรหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมการเข้ารหัสที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[in] authKey
ตัวชี้ไปยังคีย์ที่จะใช้ในการตรวจสอบสิทธิ์รหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมการตรวจสอบสิทธิ์ที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[in] fingerprintKey
ตัวชี้ไปยังกุญแจที่จะใช้สร้างลายนิ้วมือของรหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมลายนิ้วมือที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[in] passcodeBuf
ตัวชี้ไปยังบัฟเฟอร์เพื่อรับรหัสผ่านที่ถอดรหัสแล้ว
[in] passcodeBufSize
ขนาดของบัฟเฟอร์ที่ชี้ไปยังโดย PasswordBuf
[out] passcodeLen
ตั้งความยาวของรหัสผ่านที่เข้ารหัส
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG
หากระบบไม่รองรับการกําหนดค่ารหัสผ่านที่ระบุ
WEAVE_ERROR_PASSCODE_AUTHENTICATION_FAILED
หากตรวจสอบสิทธิ์รหัสผ่านไม่สําเร็จ
WEAVE_ERROR_PASSCODE_FINGERPRINT_FAILED
หากการตรวจสอบลายนิ้วมือของรหัสผ่านล้มเหลว
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์รหัสผ่านที่ระบุมีขนาดเล็กเกินไป
WEAVE_ERROR_INVALID_ARGUMENT
หากรหัสผ่านที่เข้ารหัสสั้นเกินไปหรือยาวเกินไป

เข้ารหัสรหัสผ่าน

WEAVE_ERROR EncryptPasscode(
  uint8_t config,
  uint32_t keyId,
  uint32_t nonce,
  const uint8_t *passcode,
  size_t passcodeLen,
  uint8_t *encPasscode,
  size_t encPasscodeBufSize,
  size_t & encPasscodeLen,
  GroupKeyStoreBase *groupKeyStore
)

เข้ารหัสรหัสผ่านโดยใช้รูปแบบการเข้ารหัสรหัสผ่าน Nest

รายละเอียด
พารามิเตอร์
[in] config
การกําหนดค่าการเข้ารหัสรหัสผ่านที่จะใช้
[in] keyId
รหัสคีย์การเข้ารหัสรหัสผ่านที่ขอ
[in] nonce
ค่าที่ไม่ซ้ํากันซึ่งกําหนดให้รหัสผ่านที่เข้ารหัส
[in] passcode
ตัวชี้ไปยังรหัสผ่านที่ต้องการเข้ารหัส
[in] passcodeLen
ความยาวของรหัสผ่าน
[out] encPasscode
ตัวชี้ไปยังบัฟเฟอร์เพื่อจัดเก็บรหัสผ่านที่เข้ารหัส
[in] encPasscodeBufSize
ขนาดบัฟเฟอร์ของพื้นที่เก็บข้อมูลรหัสผ่านที่เข้ารหัส
[out] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[in] groupKeyStore
ตัวชี้ไปยังออบเจ็กต์ที่เก็บคีย์ของกลุ่ม
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG
หากระบบไม่รองรับการกําหนดค่ารหัสผ่านที่ระบุ
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์เอาต์พุตมีขนาดเล็กเกินไปสําหรับรหัสผ่านที่เข้ารหัส
WEAVE_ERROR_INVALID_KEY_ID
หากคีย์ที่ขอมีรหัสคีย์ที่ไม่ถูกต้อง
WEAVE_ERROR_INVALID_ARGUMENT
หากรหัสผ่านที่ระบุสั้นหรือยาวเกินไป หรือหากไม่ได้ระบุตัวชี้ไปยังคีย์สโตร์ของกลุ่ม หรือที่เก็บคีย์ของแพลตฟอร์มแสดงพารามิเตอร์คีย์ที่ไม่ถูกต้อง
other
ข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่แสดงผลโดย API ที่เก็บข้อมูลคีย์ของแพลตฟอร์ม

เข้ารหัสรหัสผ่าน

WEAVE_ERROR EncryptPasscode(
  uint8_t config,
  uint32_t keyId,
  uint32_t nonce,
  const uint8_t *passcode,
  size_t passcodeLen,
  const uint8_t *encKey,
  const uint8_t *authKey,
  const uint8_t *fingerprintKey,
  uint8_t *encPasscode,
  size_t encPasscodeBufSize,
  size_t & encPasscodeLen
)

เข้ารหัสรหัสผ่านโดยใช้รูปแบบการเข้ารหัสรหัสผ่าน Nest

รายละเอียด
พารามิเตอร์
[in] config
กําหนดค่าการเข้ารหัสรหัสผ่าน Weave ที่จะใช้
[in] keyId
รหัสคีย์การเข้ารหัสรหัสผ่านที่ขอ
[in] nonce
ค่าที่ไม่ซ้ํากันซึ่งกําหนดให้รหัสผ่าน
[in] passcode
ตัวชี้ไปยังรหัสผ่านที่ต้องการเข้ารหัส
[in] passcodeLen
ความยาวของรหัสผ่าน
[in] encKey
ตัวชี้ไปยังคีย์ที่จะใช้เข้ารหัสรหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมการเข้ารหัสที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[in] authKey
ตัวชี้ไปยังคีย์ที่จะใช้ในการตรวจสอบสิทธิ์รหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมการตรวจสอบสิทธิ์ที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[in] fingerprintKey
ตัวชี้ไปยังกุญแจที่จะใช้สร้างลายนิ้วมือของรหัสผ่าน ความยาวของคีย์ต้องตรงกับอัลกอริทึมลายนิ้วมือที่เชื่อมโยงกับการกําหนดค่าที่ระบุ
[out] encPasscode
ตัวชี้ไปยังบัฟเฟอร์ที่จัดเก็บรหัสผ่านที่เข้ารหัส บัฟเฟอร์นี้มีขนาดอย่างน้อย kPasscodeMaxEncryptedLen
[in] encPasscodeBufSize
ขนาดของบัฟเฟอร์ที่ชี้ไปยัง encPasscode
[out] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
แสดงผลค่า
WEAVE_NO_ERROR
สําเร็จแล้ว
WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG
หากระบบไม่รองรับการกําหนดค่ารหัสผ่านที่ระบุ
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์เอาต์พุตมีขนาดเล็กเกินไปสําหรับรหัสผ่านที่เข้ารหัส
WEAVE_ERROR_INVALID_ARGUMENT
หากรหัสผ่านที่ให้มาสั้นหรือยาวเกินไป

รับรหัสผ่านที่เข้ารหัส

WEAVE_ERROR GetEncryptedPasscodeConfig(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t & config
)

รับประเภทการกําหนดค่าของรหัสผ่านที่เข้ารหัส

รายละเอียด
พารามิเตอร์
[in] encPasscode
ชี้ไปที่บัฟเฟอร์ที่มีรหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[out] config
การกําหนดค่าการเข้ารหัสรหัสผ่าน Weave ที่ใช้โดยรหัสผ่านที่เข้ารหัส

ลายนิ้วมือ PassEncryptedPasscode

WEAVE_ERROR GetEncryptedPasscodeFingerprint(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t *fingerprintBuf,
  size_t fingerprintBufSize,
  size_t & fingerprintLen
)

รับค่าลายนิ้วมือที่เชื่อมโยงกับรหัสผ่านที่เข้ารหัส

รายละเอียด
พารามิเตอร์
[in] encPasscode
ชี้ไปที่บัฟเฟอร์ที่มีรหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[in] fingerprintBuf
บัฟเฟอร์เพื่อรับค่าลายนิ้วมือ
[in] fingerprintBufSize
ขนาดของบัฟเฟอร์ที่ชี้ไปยังลายนิ้วมือลายนิ้วมือ
[out] fingerprintLen
ความยาวของค่าลายนิ้วมือที่แสดงผล

รับรหัสคีย์ที่เข้ารหัส

WEAVE_ERROR GetEncryptedPasscodeKeyId(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint32_t & keyId
)

รับรหัสของรหัสที่ใช้เข้ารหัสรหัสผ่านที่เข้ารหัส

รายละเอียด
พารามิเตอร์
[in] encPasscode
ชี้ไปที่บัฟเฟอร์ที่มีรหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[out] keyId
รหัสของคีย์ที่ใช้เข้ารหัสรหัสผ่านที่เข้ารหัสไว้

รหัสผ่าน GetEncryptedPasscode

WEAVE_ERROR GetEncryptedPasscodeNonce(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint32_t & nonce
)

รับค่า cece ที่เชื่อมโยงกับรหัสผ่านที่เข้ารหัส

รายละเอียด
พารามิเตอร์
[in] encPasscode
ชี้ไปที่บัฟเฟอร์ที่มีรหัสผ่านที่เข้ารหัส
[in] encPasscodeLen
ความยาวของรหัสผ่านที่เข้ารหัส
[out] nonce
ค่า nonces ที่เชื่อมโยงกับรหัสผ่านที่เข้ารหัส

IsSupportedPasscodeEncryptionConfig

bool IsSupportedPasscodeEncryptionConfig(
  uint8_t config
)

ส่งคืนค่า True หาก API การเข้ารหัส/การถอดรหัสรหัสผ่านรองรับการกําหนดค่าการเข้ารหัสรหัสผ่านที่ระบุ