Google is committed to advancing racial equity for Black communities. See how.
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

कोप सुरक्षित

इस मॉड्यूल में ऐसे फ़ंक्शन शामिल हैं जो CoAP Secure (CoAP over DTLS) संचार को नियंत्रित करते हैं।

सारांश

CoAP सिक्योर एपीआई फीचर ( OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE ) सक्षम होने पर इस मॉड्यूल में कार्य उपलब्ध हैं।

टंकण

otHandleCoapSecureClientConnect )(bool aConnected, void *aContext) टंकण
void(*
यह फ़ंक्शन पॉइंटर तब कहा जाता है जब DTLS कनेक्शन स्थिति बदल जाती है।

कार्य

otCoapSecureAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
यह फ़ंक्शन CoAP Secure सर्वर के लिए ब्लॉक-वार संसाधन जोड़ता है।
otCoapSecureAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
यह फ़ंक्शन CoAP Secure सर्वर के लिए एक संसाधन जोड़ता है।
otCoapSecureConnect ( otInstance *aInstance, const otSockAddr *aSockAddr, otHandleCoapSecureClientConnect aHandler, void *aContext)
यह विधि एक सहकर्मी के साथ DTLS सत्र को आरंभ करती है।
otCoapSecureDisconnect ( otInstance *aInstance)
void
यह विधि DTLS कनेक्शन को रोकती है।
otCoapSecureGetPeerCertificateBase64 ( otInstance *aInstance, unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize)
यह विधि सहकर्मी x509 प्रमाणपत्र बेस 64 एनकोडेड देता है।
otCoapSecureIsConnected ( otInstance *aInstance)
bool
यह विधि इंगित करती है कि DTLS सत्र जुड़ा हुआ है या नहीं।
otCoapSecureIsConnectionActive ( otInstance *aInstance)
bool
यह विधि इंगित करती है कि DTLS सत्र सक्रिय है या नहीं।
otCoapSecureRemoveBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
यह फ़ंक्शन CoAP Secure सर्वर से ब्लॉक-वार रिसोर्स को निकालता है।
otCoapSecureRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
यह फ़ंक्शन CoAP Secure सर्वर से एक संसाधन निकालता है।
otCoapSecureSendRequest ( otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext)
यह विधि सुरक्षित DTLS कनेक्शन पर एक CoAP अनुरोध भेजता है।
otCoapSecureSendRequestBlockWise ( otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
यह विधि सुरक्षित DTLS कनेक्शन पर एक COAP अनुरोध ब्लॉक-वार भेजता है।
otCoapSecureSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
यह फ़ंक्शन CoAP सिक्योर सर्वर से CoAP प्रतिक्रिया भेजता है।
otCoapSecureSendResponseBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
यह फ़ंक्शन CoAP प्रतिसाद ब्लॉक को-सिक्योर सर्वर से भेजता है।
otCoapSecureSetCaCertificateChain ( otInstance *aInstance, const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength)
void
यह विधि विश्वसनीय शीर्ष स्तर CAs सेट करती है।
otCoapSecureSetCertificate ( otInstance *aInstance, const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength)
void
यह विधि DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 के साथ DTLS सत्र के लिए संबंधित निजी कुंजी के साथ स्थानीय डिवाइस का X509 प्रमाणपत्र सेट करती है।
otCoapSecureSetClientConnectedCallback ( otInstance *aInstance, otHandleCoapSecureClientConnect aHandler, void *aContext)
void
यह विधि इंगित करने के लिए कनेक्टेड कॉलबैक सेट करती है, जब कोई क्लाइंट CoAP सिक्योर सर्वर से कनेक्ट होता है।
otCoapSecureSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
यह फ़ंक्शन अनचाहे CoAP सुरक्षित अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है।
otCoapSecureSetPsk ( otInstance *aInstance, const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength)
void
यह विधि पूर्व-साझा कुंजी (PSK) और सिफर सुइट DTLS_PSK_WITH_AES_128_CCM_8 सेट करती है।
otCoapSecureSetSslAuthMode ( otInstance *aInstance, bool aVerifyPeerCertificate)
void
यह विधि कोप सुरक्षित कनेक्शन के लिए प्रमाणीकरण मोड सेट करती है।
otCoapSecureStart ( otInstance *aInstance, uint16_t aPort)
यह फ़ंक्शन CoAP सिक्योर सर्विस शुरू करता है।
otCoapSecureStop ( otInstance *aInstance)
void
यह फ़ंक्शन CoAP सिक्योर सर्वर को रोकता है।

टंकण

otHandleCoapSecureClientConnect

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

यह फ़ंक्शन पॉइंटर तब कहा जाता है जब DTLS कनेक्शन स्थिति बदल जाती है।

विवरण
पैरामीटर
[in] aConnected
सच है, अगर एक कनेक्शन स्थापित किया गया था, अन्यथा झूठ।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक।

कार्य

otCoapSecureAddBlock KindResource

void otCoapSecureAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

यह फ़ंक्शन CoAP Secure सर्वर के लिए ब्लॉक-वार संसाधन जोड़ता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aResource
संसाधन के लिए एक सूचक।

otCoapSecureAddResource

void otCoapSecureAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

यह फ़ंक्शन CoAP Secure सर्वर के लिए एक संसाधन जोड़ता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aResource
संसाधन के लिए एक सूचक।

otCoapSecureConnect

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

यह विधि एक सहकर्मी के साथ DTLS सत्र को आरंभ करती है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aSockAddr
रिमोट सॉकड्रेड के लिए एक सूचक।
[in] aHandler
एक फ़ंक्शन के लिए एक पॉइंटर जिसे डीटीएलएस कनेक्शन स्थिति में परिवर्तन होने पर बुलाया जाएगा।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक।
वापसी मान
OT_ERROR_NONE
सफलतापूर्वक DTLS कनेक्शन शुरू किया।

otCoapSecureDisconnect

void otCoapSecureDisconnect(
  otInstance *aInstance
)

यह विधि DTLS कनेक्शन को रोकती है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।

otCoapSecureGetPeerCertificateBase64

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

यह विधि सहकर्मी x509 प्रमाणपत्र बेस 64 एनकोडेड देता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[out] aPeerCert
बेस 64 के इनकोडेड सर्टिफिकेट बफर को एक पॉइंटर।
[out] aCertLength
बेस 64 की लंबाई इनकोडेड पीयर सर्टिफिकेट।
[in] aCertBufferSize
APeerCert का बफर आकार।
वापसी मान
OT_ERROR_INVALID_STATE
अभी तक जुड़ा नहीं है।
OT_ERROR_NONE
सफलतापूर्वक सहकर्मी प्रमाण पत्र प्राप्त करें।
OT_ERROR_NO_BUFS
प्रमाणपत्र के लिए मेमोरी आवंटित नहीं की जा सकती।

otCoapSecureIsConnected

bool otCoapSecureIsConnected(
  otInstance *aInstance
)

यह विधि इंगित करती है कि DTLS सत्र जुड़ा हुआ है या नहीं।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
वापसी मान
TRUE
DTLS सत्र जुड़ा हुआ है।
FALSE
DTLS सत्र जुड़ा नहीं है।

otCoapSecureIsConnectionActive

bool otCoapSecureIsConnectionActive(
  otInstance *aInstance
)

यह विधि इंगित करती है कि DTLS सत्र सक्रिय है या नहीं।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
वापसी मान
TRUE
यदि DTLS सत्र सक्रिय है।
FALSE
यदि DTLS सत्र सक्रिय नहीं है।

otCoapSecureRemoveBlock KindResource

void otCoapSecureRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

यह फ़ंक्शन CoAP Secure सर्वर से ब्लॉक-वार रिसोर्स को निकालता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aResource
संसाधन के लिए एक सूचक।

otCoapSecureRemoveResource

void otCoapSecureRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

यह फ़ंक्शन CoAP Secure सर्वर से एक संसाधन निकालता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aResource
संसाधन के लिए एक सूचक।

otCoapSecureSendRequest

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

यह विधि सुरक्षित DTLS कनेक्शन पर एक CoAP अनुरोध भेजता है।

यदि किसी अनुरोध के लिए प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए। यदि संदेश आईडी हेडर में सेट नहीं है (0 के बराबर), तो यह फ़ंक्शन संदेश को अद्वितीय संदेश आईडी प्रदान करेगा।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aMessage
संदेश भेजने के लिए एक संदर्भ।
[in] aHandler
एक फ़ंक्शन पॉइंटर जिसे प्रतिक्रिया रिसेप्शन या टाइम-आउट पर बुलाया जाएगा।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक।
वापसी मान
OT_ERROR_NONE
सफलतापूर्वक संदेश भेजा गया।
OT_ERROR_NO_BUFS
पुनर्प्राप्ति डेटा आवंटित करने में विफल।
OT_ERROR_INVALID_STATE
DTLS कनेक्शन आरंभ नहीं हुआ था।

otCoapSecureSendRequestBlock Kind

otError otCoapSecureSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

यह विधि सुरक्षित DTLS कनेक्शन पर एक COAP अनुरोध ब्लॉक-वार भेजता है।

यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।

यदि किसी अनुरोध की प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए। यदि संदेश आईडी हेडर में सेट नहीं है (0 के बराबर), तो यह फ़ंक्शन संदेश को अद्वितीय संदेश आईडी प्रदान करेगा।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aMessage
संदेश भेजने के लिए एक संदर्भ।
[in] aHandler
एक फ़ंक्शन पॉइंटर जिसे प्रतिक्रिया रिसेप्शन या टाइम-आउट पर बुलाया जाएगा।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक।
[in] aTransmitHook
एक फ़ंक्शन पॉइंटर जिसे ब्लॉक 1 प्रतिक्रिया रिसेप्शन पर कहा जाता है।
[in] aReceiveHook
एक फ़ंक्शन पॉइंटर जिसे ब्लॉक 2 प्रतिक्रिया रिसेप्शन पर कहा जाता है।
वापसी मान
OT_ERROR_NONE
सफलतापूर्वक संदेश भेजा गया।
OT_ERROR_NO_BUFS
पुन: प्रसारण डेटा आवंटित करने में विफल।
OT_ERROR_INVALID_STATE
DTLS कनेक्शन आरंभ नहीं हुआ था।

otCoapSecureSendResponse

००६ 00६१३०४०

यह फ़ंक्शन CoAP सिक्योर सर्वर से CoAP प्रतिक्रिया भेजता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aMessage
भेजने के लिए CoAP प्रतिक्रिया के लिए एक सूचक।
[in] aMessageInfo
के साथ जुड़े संदेश की जानकारी के लिए एक सूचक aMessage
वापसी मान
OT_ERROR_NONE
सीओएपी प्रतिक्रिया संदेश को सफलतापूर्वक संलग्न किया।
OT_ERROR_NO_BUFS
सीओएपी प्रतिक्रिया भेजने के लिए उपलब्ध अपर्याप्त बफ़र्स।

otCoapSecureSendResponseBlock Kind

otError otCoapSecureSendResponseBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)
है

यह फ़ंक्शन CoAP प्रतिसाद ब्लॉक को-सिक्योर सर्वर से भेजता है।

यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aMessage
भेजने के लिए CoAP प्रतिक्रिया के लिए एक सूचक।
[in] aMessageInfo
के साथ जुड़े संदेश की जानकारी के लिए एक सूचक aMessage
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक। इस्तेमाल न होने पर NULL हो सकता है।
[in] aTransmitHook
एक फ़ंक्शन पॉइंटर जिसे ब्लॉक 1 अनुरोध रिसेप्शन पर कहा जाता है।
वापसी मान
OT_ERROR_NONE
सीओएपी प्रतिक्रिया संदेश को सफलतापूर्वक संलग्न किया।
OT_ERROR_NO_BUFS
सीओएपी प्रतिक्रिया भेजने के लिए उपलब्ध अपर्याप्त बफ़र्स।

otCoapSecureSetCaCertificateChain

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

यह विधि विश्वसनीय शीर्ष स्तर CAs सेट करती है।

यह सहकर्मी के प्रमाण पत्र को मान्य करने के लिए आवश्यक है।

DTLS मोड "ECDHE ECDSA एईएस 128 CCM 8 के साथ" अनुप्रयोग CoAPS के लिए।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aX509CaCertificateChain
PEM के लिए एक सूचक X509 CA श्रृंखला स्वरूपित करता है।
[in] aX509CaCertChainLength
श्रृंखला की लंबाई।

otCoapSecureSetCertificate

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

यह विधि DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 के साथ DTLS सत्र के लिए संबंधित निजी कुंजी के साथ स्थानीय डिवाइस का X509 प्रमाणपत्र सेट करती है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aX509Cert
PEM के लिए एक सूचक X509 प्रमाणपत्र स्वरूपित करता है।
[in] aX509Length
प्रमाण पत्र की लंबाई।
[in] aPrivateKey
PEM के लिए एक सूचक निजी कुंजी स्वरूपित करता है।
[in] aPrivateKeyLength
निजी कुंजी की लंबाई।

otCoapSecureSetClientConnectedCallback

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

यह विधि इंगित करने के लिए कनेक्टेड कॉलबैक सेट करती है, जब कोई क्लाइंट CoAP सिक्योर सर्वर से कनेक्ट होता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aHandler
DTLS कनेक्शन स्थापित होने के बाद एक फ़ंक्शन का पॉइंटर जिसे कहा जाएगा।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक। इस्तेमाल न होने पर NULL हो सकता है।

otCoapSecureSetDefaultHandler

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

यह फ़ंक्शन अनचाहे CoAP सुरक्षित अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aHandler
एक फंक्शन पॉइंटर जिसे अनहैंड रिक्वेस्ट आने पर कॉल किया जाएगा।
[in] aContext
मनमाने ढंग से संदर्भ जानकारी के लिए एक सूचक। इस्तेमाल न होने पर NULL हो सकता है।

otCoapSecureSetPsk

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

यह विधि पूर्व-साझा कुंजी (PSK) और सिफर सुइट DTLS_PSK_WITH_AES_128_CCM_8 सेट करती है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aPsk
PSK के लिए एक सूचक।
[in] aPskLength
PSK की लंबाई।
[in] aPskIdentity
PSK के लिए पहचान नाम।
[in] aPskIdLength
PSK पहचान लंबाई।

otCoapSecureSetSslAuthMode

void otCoapSecureSetSslAuthMode(
  otInstance *aInstance,
  bool aVerifyPeerCertificate
)

यह विधि कोप सुरक्षित कनेक्शन के लिए प्रमाणीकरण मोड सेट करती है।

सहकर्मी प्रमाणपत्र के सत्यापन को अक्षम या सक्षम करें। शुरू करने से पहले बुलाया जाना चाहिए।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aVerifyPeerCertificate
सच है, सहकर्मी प्रमाणपत्र को सत्यापित करने के लिए।

otCoapSecureStart

otError otCoapSecureStart(
  otInstance *aInstance,
  uint16_t aPort
)

यह फ़ंक्शन CoAP सिक्योर सर्विस शुरू करता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।
[in] aPort
करने के लिए बाध्य करने के लिए स्थानीय UDP पोर्ट।
वापसी मान
OT_ERROR_NONE
CoAP सिक्योर सर्वर को सफलतापूर्वक शुरू किया।

otCoapSecureStop

void otCoapSecureStop(
  otInstance *aInstance
)

यह फ़ंक्शन CoAP सिक्योर सर्वर को रोकता है।

विवरण
पैरामीटर
[in] aInstance
एक OpenThread उदाहरण के लिए एक सूचक।

मैक्रों

OT_DEFAULT_COAP_SECURE_PORT

 OT_DEFAULT_COAP_SECURE_PORT 5684

डिफ़ॉल्ट CoAP सुरक्षित पोर्ट, जैसा कि RFC 7252 में निर्दिष्ट है।