Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

CoAP Secure

Mô-đun này bao gồm các chức năng điều khiển giao tiếp CoAP Secure (CoAP qua DTLS).

Tóm lược

Các chức năng trong mô-đun này khả dụng khi tính năng API bảo mật OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE ( OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE ) được bật.

Typedefs

otHandleCoapSecureClientConnect )(bool aConnected, void *aContext) typedef
void(*
Con trỏ chức năng này được gọi khi trạng thái kết nối DTLS thay đổi.

Chức năng

otCoapSecureAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
Chức năng này thêm một tài nguyên vào máy chủ CoAP Secure.
otCoapSecureConnect ( otInstance *aInstance, const otSockAddr *aSockAddr, otHandleCoapSecureClientConnect aHandler, void *aContext)
Phương thức này khởi tạo phiên DTLS với một trình ngang hàng.
otCoapSecureDisconnect ( otInstance *aInstance)
void
Phương pháp này dừng kết nối DTLS.
otCoapSecureGetPeerCertificateBase64 ( otInstance *aInstance, unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize)
Phương thức này trả về mã hóa base64 chứng chỉ x509 ngang hàng.
otCoapSecureIsConnected ( otInstance *aInstance)
bool
Phương thức này cho biết phiên DTLS có được kết nối hay không.
otCoapSecureIsConnectionActive ( otInstance *aInstance)
bool
Phương thức này cho biết phiên DTLS có đang hoạt động hay không.
otCoapSecureRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
Chức năng này xóa tài nguyên khỏi máy chủ CoAP Secure.
otCoapSecureSendRequest ( otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext)
Phương thức này gửi yêu cầu CoAP qua kết nối DTLS an toàn.
otCoapSecureSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Chức năng này gửi phản hồi CoAP từ máy chủ CoAP Secure.
otCoapSecureSetCaCertificateChain ( otInstance *aInstance, const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength)
void
Phương pháp này đặt CA cấp cao nhất đáng tin cậy.
otCoapSecureSetCertificate ( otInstance *aInstance, const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength)
void
Phương thức này đặt chứng chỉ X509 của thiết bị cục bộ với khóa riêng tương ứng cho phiên DTLS với DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
otCoapSecureSetClientConnectedCallback ( otInstance *aInstance, otHandleCoapSecureClientConnect aHandler, void *aContext)
void
Phương pháp này đặt lệnh gọi lại được kết nối để chỉ ra, khi Máy khách kết nối với máy chủ CoAP Secure.
otCoapSecureSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
Hàm này đặt trình xử lý mặc định cho các yêu cầu CoAP Secure chưa được xử lý.
otCoapSecureSetPsk ( otInstance *aInstance, const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength)
void
Phương pháp này đặt Khóa chia sẻ trước (PSK) và bộ mật mã DTLS_PSK_WITH_AES_128_CCM_8.
otCoapSecureSetSslAuthMode ( otInstance *aInstance, bool aVerifyPeerCertificate)
void
Phương pháp này đặt chế độ xác thực cho kết nối an toàn coap.
otCoapSecureStart ( otInstance *aInstance, uint16_t aPort)
Chức năng này khởi động dịch vụ CoAP Secure.
otCoapSecureStop ( otInstance *aInstance)
void
Chức năng này dừng máy chủ CoAP Secure.

Typedefs

otHandleCoapSecureClientConnect

void(* otHandleCoapSecureClientConnect)(bool aConnected, void *aContext)

Con trỏ chức năng này được gọi khi trạng thái kết nối DTLS thay đổi.

Chi tiết
Thông số
[in] aConnected
true, nếu kết nối được thiết lập, false nếu không.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý.

Chức năng

otCoapSecureAddResource

void otCoapSecureAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Chức năng này thêm một tài nguyên vào máy chủ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aResource
Một con trỏ đến tài nguyên.

otCoapSecureConnect

otError otCoapSecureConnect(
  otInstance *aInstance,
  const otSockAddr *aSockAddr,
  otHandleCoapSecureClientConnect aHandler,
  void *aContext
)

Phương thức này khởi tạo phiên DTLS với một trình ngang hàng.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aSockAddr
Một con trỏ đến sockaddr từ xa.
[in] aHandler
Một con trỏ đến một hàm sẽ được gọi khi trạng thái kết nối DTLS thay đổi.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý.
Giá trị trả lại
OT_ERROR_NONE
Đã khởi động thành công kết nối DTLS.

otCoapSecureDisconnect

void otCoapSecureDisconnect(
  otInstance *aInstance
)

Phương pháp này dừng kết nối DTLS.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.

otCoapSecureGetPeerCertificateBase64

otError otCoapSecureGetPeerCertificateBase64(
  otInstance *aInstance,
  unsigned char *aPeerCert,
  size_t *aCertLength,
  size_t aCertBufferSize
)

Phương thức này trả về mã hóa base64 chứng chỉ x509 ngang hàng.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[out] aPeerCert
Một con trỏ đến bộ đệm chứng chỉ được mã hóa base64.
[out] aCertLength
Độ dài của chứng chỉ ngang hàng được mã hóa base64.
[in] aCertBufferSize
Kích thước bộ đệm của aPeerCert.
Giá trị trả lại
OT_ERROR_INVALID_STATE
Chưa kết nối.
OT_ERROR_NONE
Nhận chứng chỉ ngang hàng thành công.
OT_ERROR_NO_BUFS
Không thể cấp phát bộ nhớ cho chứng chỉ.

otCoapSecureIsConnected

bool otCoapSecureIsConnected(
  otInstance *aInstance
)

Phương thức này cho biết phiên DTLS có được kết nối hay không.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Giá trị trả lại
TRUE
Phiên DTLS được kết nối.
FALSE
Phiên DTLS không được kết nối.

otCoapSecureIsConnectionActive

bool otCoapSecureIsConnectionActive(
  otInstance *aInstance
)

Phương thức này cho biết phiên DTLS có đang hoạt động hay không.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Giá trị trả lại
TRUE
Nếu phiên DTLS đang hoạt động.
FALSE
Nếu phiên DTLS không hoạt động.

otCoapSecureRemoveResource

void otCoapSecureRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Chức năng này xóa tài nguyên khỏi máy chủ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aResource
Một con trỏ đến tài nguyên.

otCoapSecureSendRequest

otError otCoapSecureSendRequest(
  otInstance *aInstance,
  otMessage *aMessage,
  otCoapResponseHandler aHandler,
  void *aContext
)

Phương thức này gửi yêu cầu CoAP qua kết nối DTLS an toàn.

Nếu mong đợi một phản hồi cho một yêu cầu, thông tin về chức năng và ngữ cảnh tương ứng phải được cung cấp. Nếu không mong đợi phản hồi, các đối số này phải là con trỏ NULL. Nếu Id Thông báo không được đặt trong tiêu đề (bằng 0), chức năng này sẽ gán Id Thông báo duy nhất cho thư.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Tham chiếu đến tin nhắn cần gửi.
[in] aHandler
Một con trỏ chức năng sẽ được gọi khi nhận phản hồi hoặc hết thời gian.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý.
Giá trị trả lại
OT_ERROR_NONE
Đã gửi thành công tin nhắn CoAP.
OT_ERROR_NO_BUFS
Không thể phân bổ dữ liệu truyền lại.
OT_ERROR_INVALID_STATE
Kết nối DTLS không được khởi tạo.

otCoapSecureSendResponse

otError otCoapSecureSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Chức năng này gửi phản hồi CoAP từ máy chủ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Một con trỏ đến phản hồi CoAP để gửi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn được liên kết với aMessage .
Giá trị trả lại
OT_ERROR_NONE
Đã xếp hàng thành công thông báo phản hồi CoAP.
OT_ERROR_NO_BUFS
Không có đủ bộ đệm để gửi phản hồi CoAP.

otCoapSecureSetCaCertificateChain

void otCoapSecureSetCaCertificateChain(
  otInstance *aInstance,
  const uint8_t *aX509CaCertificateChain,
  uint32_t aX509CaCertChainLength
)

Phương pháp này đặt CA cấp cao nhất đáng tin cậy.

Nó cần thiết để xác thực chứng chỉ của đồng đẳng.

Chế độ DTLS "ECDHE ECDSA với AES 128 CCM 8" cho CoAPS ứng dụng.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aX509CaCertificateChain
Một con trỏ đến chuỗi X509 CA được định dạng PEM.
[in] aX509CaCertChainLength
Chiều dài của chuỗi.

otCoapSecureSetCertificate

void otCoapSecureSetCertificate(
  otInstance *aInstance,
  const uint8_t *aX509Cert,
  uint32_t aX509Length,
  const uint8_t *aPrivateKey,
  uint32_t aPrivateKeyLength
)

Phương thức này đặt chứng chỉ X509 của thiết bị cục bộ với khóa riêng tương ứng cho phiên DTLS với DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aX509Cert
Một con trỏ đến chứng chỉ X509 được định dạng PEM.
[in] aX509Length
Độ dài của chứng chỉ.
[in] aPrivateKey
Một con trỏ đến khóa cá nhân được định dạng PEM.
[in] aPrivateKeyLength
Độ dài của khóa riêng.

otCoapSecureSetClientConnectedCallback

void otCoapSecureSetClientConnectedCallback(
  otInstance *aInstance,
  otHandleCoapSecureClientConnect aHandler,
  void *aContext
)

Phương pháp này đặt lệnh gọi lại được kết nối để chỉ ra, khi Máy khách kết nối với máy chủ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aHandler
Một con trỏ đến một hàm sẽ được gọi khi kết nối DTLS được thiết lập.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý. Có thể là NULL nếu không được sử dụng.

otCoapSecureSetDefaultHandler

void otCoapSecureSetDefaultHandler(
  otInstance *aInstance,
  otCoapRequestHandler aHandler,
  void *aContext
)

Hàm này đặt trình xử lý mặc định cho các yêu cầu CoAP Secure chưa được xử lý.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aHandler
Một con trỏ hàm sẽ được gọi khi có yêu cầu chưa xử lý.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý. Có thể là NULL nếu không được sử dụng.

otCoapSecureSetPsk

void otCoapSecureSetPsk(
  otInstance *aInstance,
  const uint8_t *aPsk,
  uint16_t aPskLength,
  const uint8_t *aPskIdentity,
  uint16_t aPskIdLength
)

Phương pháp này đặt Khóa chia sẻ trước (PSK) và bộ mật mã DTLS_PSK_WITH_AES_128_CCM_8.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aPsk
Một con trỏ tới PSK.
[in] aPskLength
Độ dài PSK.
[in] aPskIdentity
Tên nhận dạng cho PSK.
[in] aPskIdLength
Độ dài nhận dạng PSK.

otCoapSecureSetSslAuthMode

void otCoapSecureSetSslAuthMode(
  otInstance *aInstance,
  bool aVerifyPeerCertificate
)

Phương pháp này đặt chế độ xác thực cho kết nối an toàn coap.

Tắt hoặc bật xác minh chứng chỉ ngang hàng. Phải được gọi trước khi bắt đầu.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aVerifyPeerCertificate
true, để xác minh chứng chỉ ngang hàng.

otCoapSecureStart

otError otCoapSecureStart(
  otInstance *aInstance,
  uint16_t aPort
)

Chức năng này khởi động dịch vụ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aPort
Cổng UDP cục bộ để liên kết.
Giá trị trả lại
OT_ERROR_NONE
Khởi động thành công máy chủ CoAP Secure.

otCoapSecureStop

void otCoapSecureStop(
  otInstance *aInstance
)

Chức năng này dừng máy chủ CoAP Secure.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.

Macro

OT_DEFAULT_COAP_SECURE_PORT

 OT_DEFAULT_COAP_SECURE_PORT 5684

Cổng CoAP Secure mặc định, như được chỉ định trong RFC 7252.