Changeset 5755 for pjproject/trunk/pjmedia/include/pjmedia/transport_srtp.h

Timestamp:

Mar 15, 2018 3:00:59 AM (6 years ago)

Author:

nanang

Message:

Close #2100:

• Added new APIs:
  • PJMEDIA: pjmedia_srtp_enum_crypto(), pjmedia_srtp_enum_keying()
  • PJSUA: pjsua_config.srtp_opt, pjsua_acc_config.srtp_opt, pjsua_srtp_opt_default()
  • PJSUA2: AccountMediaConfig::srtpOpt, Endpoint::srtpCryptoEnum()
• Deprecated PJSUA callback on_create_media_transport_srtp() (not removed yet, just warnings).
• Slightly refactored SRTP code:
  • Fixed potential issue with on_create_media_transport_srtp(), some PJSUA internal values in pjmedia_srtp_setting may be overridden by app.
  • Fixed few issues in SRTP and keying mechanism, e.g: premature local SDP modification (it should be done after verification).
  • Potential minor backward compatibility issue: default value of pjmedia_srtp_setting.crypto_count is now zero, previously it was initialized with all crypto via pjmedia_srtp_setting_default(), actually zero and all cryptos in this setting semantically are the same.

File:

• pjproject/trunk/pjmedia/include/pjmedia/transport_srtp.h (modified) (4 diffs)

pjproject/trunk/pjmedia/include/pjmedia/transport_srtp.h

@@ -191 +191 @@
 
     /**
-     * Specify the number of crypto suite settings.
+     * Specify the number of crypto suite settings. If set to zero, all
+     * available cryptos will be enabled. Default: zero.
      */
     unsigned                     crypto_count;
 
     /**
-     * Specify individual crypto suite setting.
+     * Specify individual crypto suite setting and its priority order.
+     *
      * Notes for DTLS-SRTP keying:
      *  - Currently only supports these cryptos: AES_CM_128_HMAC_SHA1_80,
@@ -205 +207 @@
 
     /**
-     * Specify the number of enabled keying methods.
-     * Default is PJMEDIA_SRTP_MAX_KEYINGS (all enabled).
+     * Specify the number of enabled keying methods. If set to zero, all
+     * keyings will be enabled. Maximum value is PJMEDIA_SRTP_MAX_KEYINGS.
+     *
+     * Default is zero (all keyings are enabled with priority order:
+     * SDES, DTLS-SRTP).
      */
     unsigned                     keying_count;
@@ -215 +220 @@
      * for example as currently only one keying is supported in the SDP offer,
      * keying with first priority will be likely used in the SDP offer.
-     *
-     * Default is that all supported keying methods (i.e: currently SDES and
-     * DTLS-SRTP) will be enabled and with priority order: SDES, DTLS-SRTP.
      */
     pjmedia_srtp_keying_method   keying[PJMEDIA_SRTP_KEYINGS_COUNT];
@@ -321 +323 @@
  */
 PJ_DECL(void) pjmedia_srtp_setting_default(pjmedia_srtp_setting *opt);
+
+
+/**
+ * Enumerate available SRTP crypto name.
+ *
+ * @param count     On input, specifies the maximum length of crypto
+ *                  array. On output, the number of available crypto
+ *                  initialized by this function.
+ * @param crypto    The SRTP crypto array output.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_srtp_enum_crypto(unsigned *count,
+                                              pjmedia_srtp_crypto crypto[]);
+
+
+/**
+ * Enumerate available SRTP keying methods.
+ *
+ * @param count     On input, specifies the maximum length of keying method
+ *                  array. On output, the number of available keying method
+ *                  initialized by this function.
+ * @param crypto    The SRTP keying method array output.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_srtp_enum_keying(unsigned *count,
+                                      pjmedia_srtp_keying_method keying[]);