Skip to content

Proposal to add support for RFC 7714 SRTP with AES-GCM #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jcbeaulieu wants to merge 19 commits into from
Closed

Proposal to add support for RFC 7714 SRTP with AES-GCM #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d40607a
Proposal to add support for RFC 7714 SRTP with AES-GCM with security …
jcbeaulieu May 7, 2024
1841d6b
Revert "Proposal to add support for RFC 7714 SRTP with AES-GCM with s…
jcbeaulieu Jun 14, 2024
9a6ee0c
Added section on SRTP encryption algorithm negotiation
jcbeaulieu Oct 4, 2024
03c5e3c
Removed reference to security extensions and added reference to the I…
jcbeaulieu Dec 5, 2024
83d515a
Revert "Removed reference to security extensions and added reference …
jcbeaulieu Feb 11, 2025
a6e9d1d
Revert "Added section on SRTP encryption algorithm negotiation"
jcbeaulieu Feb 11, 2025
8da15d8
Changed SRTP streaming negotiation from RTSP to Media2 wsdl
jcbeaulieu Feb 11, 2025
e83014d
Changed tabs to spaces
jcbeaulieu Feb 11, 2025
1b8b3fc
Fixed tabs vs spaces indentation
jcbeaulieu Feb 12, 2025
d2a0c63
Additional formatting fixes in streaming.xml
jcbeaulieu Feb 12, 2025
e7500dd
Merge branch 'development' into video/srtp-aes_gcm
jcbeaulieu Feb 12, 2025
8310d9b
Added NONE option to RTSPS streaming
jcbeaulieu Feb 12, 2025
dd6e679
Merge branch 'video/srtp-aes_gcm' of https://github.com/jcbeaulieu/on…
jcbeaulieu Feb 12, 2025
87bda26
Moved srtp configuration to encoder configurations
jcbeaulieu Mar 11, 2025
5fc82a4
Remove changes to formatting
jcbeaulieu Mar 12, 2025
be79f84
Removed references to GetStreamUri2
jcbeaulieu Mar 12, 2025
67a12c1
Removed more formatting changes
jcbeaulieu Mar 12, 2025
959c3f3
Added SecureRTSPStreaming to media1
jcbeaulieu Mar 13, 2025
680af5e
Streaming spec draft
jcbeaulieu May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 206 additions & 3 deletions doc/Streaming.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,7 @@
<para>IETF RFC 2435, RFC2435 - RTP Payload Format for JPEG-compressed Video</para>
<para role="reference">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc2435.txt"></link>&gt;</para>
<para>IETF RFC 3016, RTP Payload Format for MPEG-4 Audio/Visual Streams</para>
<programlisting><![CDATA[http://www.ietf.org/rfc/rfc3016.txt
]]></programlisting>
<para role="reference">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc3016"></link>&gt;</para>
<para>IETF RFC 3550, RTP: A Transport Protocol for Real-Time Applications</para>
<para role="reference">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org/rfc/rfc3550.txt"></link>&gt;</para>
<para>IETF RFC 3551, RTP Profile for Audio and Video Conferences with Minimal Control</para>
Expand Down Expand Up @@ -381,6 +380,22 @@
</entry>
</row>
<row>
<entry valign="middle">
<para>MIKEY</para>
</entry>
<entry valign="middle">
<para>Multimedia Internet KEYing</para>
</entry>
</row>
<row>
<entry valign="middle">
<para>MKI</para>
</entry>
<entry valign="middle">
<para>Master Key Identifier</para>
</entry>
</row>
<row>
<entry valign="middle">
<para>MPEG-4</para>
</entry>
Expand Down Expand Up @@ -590,7 +605,195 @@
</section>
<section>
<title>SRTP data transfer via UDP</title>
<para>This mode allows secure transmission of RTP packets via UDP unicast and multicast. See RFC 3711 for transmission and RFC 4567 for key exchange.</para>
<para>This mode allows secure transmission of RTP packets via UDP unicast and multicast. Related documents are RFC 3711, RFC 7714 for transmission and RFC 3830, RFC 4567 for key exchange.</para>
<para>
The device must list whether or not it supports SRTP streaming through the GetServiceCapabilities action's response. If the device supports SRTP streaming, the device must indicate it through the SecureRTSPStreaming parameter in the StreamingCapabilities.
</para>
<section>
<title>Cryptographic algorithm negotiation</title>

<para>
The device may list which SRTP cryptographic algorithms it supports through the Media1 and Media2 wsdls.
Each encoder can list the algorithms it supports through the SecureStreamingProtocolAlgorithms element present in:
<itemizedlist>
<listitem>
<para>AudioEncoderConfigurationOptions</para>
</listitem>
<listitem>
<para>MetadataConfigurationOptions</para>
</listitem>
<listitem>
<para>VideoEncoderConfigurationOptions</para>
</listitem>
<listitem>
<para>AudioEncoder2ConfigurationOptions</para>
</listitem>
<listitem>
<para>VideoEncoder2ConfigurationOptions</para>
</listitem>
</itemizedlist>

If the SecureStreamingProtocolAlgorithms parameter is present, the device must support a least one of the following algorithms:
<itemizedlist>
<listitem>
<para>NONE</para>
<para>NONE is a special case, where the media is listed as RTP/AVP instead of RTP/SAVP and where MIKEY is unused altogether.</para>
<para>This it to allow the use of RTSPS to authenticate with the camera without using encrypted media streams.</para>
</listitem>
<listitem>
<para>AES_CM_128_HMAC_SHA1_80</para>
</listitem>
<listitem>
<para>AEAD_AES_128_GCM</para>
</listitem>
<listitem>
<para>AEAD_AES_256_GCM</para>
</listitem>
</itemizedlist>
If the device supports SRTP streaming through the SecureRTSPStreaming parameter, but does not list any supported SRTP cryptographic algorithms through the SecureStreamingProtocolAlgorithms parameter, the device shall support the AES_CM_128_SHA1_80 algorithm as defined in RFC 3711.
</para>

<para>
The client may choose to configure a device to use a specific algorithm. To do so, it must set the SecureStreamingProtocolAlgorithm attribute through the following actions:
<itemizedlist>
<listitem>
<para>SetAudioEncoderConfiguration</para>
</listitem>
<listitem>
<para>SetMetadataConfiguration</para>
</listitem>
<listitem>
<para>SetVideoEncoderConfiguration</para>
</listitem>
</itemizedlist>
</para>

<para>
If a device supports encryption algorithms other than AES_CM_128_SHA1_80 as defined in RFC 3711, it must also support the ConfigurationOptions and the actions listed above.
This mechanism allows the client to choose the encryption algorithm used by the device for SRTP.
</para>

<para>
MIKEY is used for key management for SRTP. The device shall support MIKEY as defined in RFC 3830 for key management.
One exception is that in RFC 3830, support for MIKEY-PSK and MIKEY-PK are listed mandatory. For ONVIF SRTP, only MIKEY-PSK support is defined and mandatory.
MIKEY-PK should not be used for ONVIF SRTP.
</para>
<para>
The MIKEY message must contain the following payloads:
<itemizedlist>
<listitem>
<para>Common Header Payload</para>
</listitem>
<listitem>
<para>KEMAC Payload</para>
<para>The KEMAC payload should not be encrypted since TLS already encrypts the RTSPS channel.</para>
<para>If the key type is TEK without salt and a salt must be provided, the key and the salt must be concatenated and sent in the Key data section of the payload.</para>
<para>(To verify, some cameras return RTP packets when this is done?)If the key type is TEK+SALT and a salt must be provided, the SALT must be in the Salt data section.</para>
<para>The device and client must support TEK for AES_CM_128_SHA1_80 and TEK+SALT for other encryption algorithms.</para>
<para>To keep track of key validity, The SPI/MKI must be set in the KV data. The SRTP packets must also include the MKI.</para>
</listitem>
<listitem>
<para>Security Policy Payload</para>
<para>
Specifies the encryption parameters to be used by the streams.
<itemizedlist>
<listitem>
<para>AES_CM_128_HMAC_SHA1_80</para>
<para>Encryption Algorithm: AES-CM</para>
<para>Session Encryption Key Length: 128 bits</para>
<para>Authentication Algorithm: HMAC-SHA-1</para>
<para>Session Auth Key Length: 160 bits</para>
<para>Session Salt Key Length: 112 bits</para>
<para>SRTP Encryption: On</para>
<para>SRTCP Encryption: On</para>
<para>Authnetication Tag Length: 80 bits</para>
<para>SRTP PRF: AES-CM</para>
</listitem>
<listitem>
<para>AEAD_AES_128_GCM</para>
<para>Encryption Algorithm: AES-GCM</para>
<para>Session Encryption Key Length: 128 bits</para>
<para>Authentication Algorithm: NULL</para>
<para>Session Auth Key Length: N/A</para>
<para>Session Salt Key Length: 96 bits</para>
<para>SRTP Encryption: On</para>
<para>SRTCP Encryption: On</para>
<para>AEAD Authnetication Tag Length: 16 octets</para>
<para>SRTP PRF: AES-CM</para>
</listitem>
<listitem>
<para>AEAD_AES_256_GCM</para>
<para>Encryption Algorithm: AES-GCM</para>
<para>Session Encryption Key Length: 256 bits</para>
<para>Authentication Algorithm: NULL</para>
<para>Session Auth Key Length: N/A</para>
<para>Session Salt Key Length: 96 bits</para>
<para>SRTP Encryption: On</para>
<para>SRTCP Encryption: On</para>
<para>AEAD Authnetication Tag Length: 16 octets</para>
<para>SRTP PRF: AES-CM</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
<para>
The key management extensions for SDP and RTSP (RFC 4567) allow for key management through RTSP.
<section>
<title>Key management through RTSP</title>
<section>
<title>Stream Initialization</title>
<para>
Key management extensions for SDP and RTSP (RFC 4567) defines stream initialization.
</para>
<para>
When the device is providing the key, the SDP is required to have a media of type RTP/SAVP and a MIKEY message.
It's permitted to have two media fields, one with RTP/AVP and one with RTP/SAVP. The RTP/AVP track is used for unencrypted streaming.
<programlisting><![CDATA[v=0
o=actionmovie 2891092738 2891092738 IN IP4 movie.example.com
s=Action Movie
e=action@movie.example.com
t=0 0
c=IN IP4 movie.example.com
a=control:rtsp://movie.example.com/action
m=video 0 RTP/SAVP 98
a=rtpmap:98 H264/8000
a=key-mgmt:mikey AQAFgM0XflABAAAAAAAAAAAAA...
a=control:rtsp://movie.example.com/action/srtp_video
m=video 0 RTP/AVP 99
a=rtpmap:99 H264/90000
a=control:rtsp://movie.example.com/action/rtp_video
]]></programlisting>
</para>
<para>
When the client is providing the key, it will add a KeyMgmt header containing the MIKEY with transport type RTP/SAVP in the SETUP.
The client may use a different encryption algorithm than what is configured with SetAudioEncoderConfiguration, SetMetadataConfiguration and SetVideoEncoderConfiguration.
The GetAudioEncoderConfiguration, GetMetadataConfiguration and GetVideoEncoderConfiguration responses shall not be affected by the encryption algorithm configured through RTSP with MIKEY.
SetAudioEncoderConfiguration, SetMetadataConfiguration and SetVideoEncoderConfiguration shall only be used to configure the device for the default encryption algorithm sent in the DESCRIBE.
<programlisting><![CDATA[SETUP rtsp://<RTSP_URI> RTSP/1.0
CSeq: 2
User-Agent: OmnicastRTSPClient/1.0
Transport: RTP/SAVP/UDP;unicast
KeyMgmt: prot=mikey;uri="";data="AQAFAP1td9ABAADCD1UcAAAAAAoAAdOOGc75XD0BAAAAGAABAQEBE
AIBAQMBFAcBAQgBAQoBAQsBCgAAACcAIQAe30C59UrClE0e27UP5h/Wty9UL8+dfzg+2ttmmo3kBAAAAC8A"
]]></programlisting>
</para>
</section>
<section>
<title>Client Re-Keying with MIKEY</title>
<para>
The client may request the use of new keys for stream encryption.
The SET_PARAMETER method shall be used with a mikey parameter to set the new encryption keys.
The client may use a different encryption algorithm than what is configured with the SetAudioEncoderConfiguration, SetMetadataConfiguration and SetVideoEncoderConfiguration actions.
</para>
</section>
<section>
<title>Multicast considerations</title>
</section>
</section>
</para>
</section>
</section>
<section xml:id="_Ref213038219">
<title>RTP/RTSP/HTTP/TCP</title>
Expand Down
5 changes: 5 additions & 0 deletions wsdl/ver10/media/wsdl/media.wsdl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FO
<xs:documentation> Indicates the device does not support live media streaming via RTSP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SecureRTSPStreaming" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Indicates support for live media streaming via RTSPS and SRTP.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute processContents="lax"/>
</xs:complexType>
<!--===============================-->
Expand Down
Loading