1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<HTML>
<HEAD>
<TITLE>class RTPSecure</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class RTPSecure</h1>
</TD>
<TD valign="top" align="right" colspan="1">SRTP implementation. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::RTPSecure</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___yrtp___yatertp_h.html">libs/yrtp/yatertp.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__GenObject.html">TelEngine::GenObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__RTPSecure.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref4">RTPSecure</A></b> ()
</LI>
<LI> <b><A HREF="#ref5">RTPSecure</A></b> (const String& suite)
</LI>
<LI> <b><A HREF="#ref6">RTPSecure</A></b> (const RTPSecure& other)
</LI>
<LI>virtual <b><A HREF="#ref7">~RTPSecure</A></b> ()
</LI>
<LI>inline RTPBaseIO* <b><A HREF="#ref8">owner</A></b> () const
</LI>
<LI>void <b><A HREF="#ref9">owner</A></b> (RTPBaseIO* newOwner)
</LI>
<LI>inline Cipher* <b><A HREF="#ref10">rtpCipher</A></b> () const
</LI>
<LI>virtual bool <b><A HREF="#ref11">supported</A></b> (RTPSession* session = 0) const
</LI>
<LI>virtual bool <b><A HREF="#ref12">setup</A></b> (const String& suite, const String& keyParams, const ObjList* paramList = 0)
</LI>
<LI>virtual bool <b><A HREF="#ref13">create</A></b> (String& suite, String& keyParams, bool buildMaster = true)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref14">init</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref15">rtpEncipher</A></b> (unsigned char* data, int len)
</LI>
<LI>virtual void <b><A HREF="#ref16">rtpAddIntegrity</A></b> (const unsigned char* data, int len, unsigned char* authData)
</LI>
<LI>virtual bool <b><A HREF="#ref17">rtpDecipher</A></b> (unsigned char* data, int len, const void* secData, <A HREF="#u_int32_t">u_int32_t</A> ssrc, <A HREF="#u_int64_t">u_int64_t</A> seq)
</LI>
<LI>virtual bool <b><A HREF="#ref18">rtpCheckIntegrity</A></b> (const unsigned char* data, int len, const void* authData, <A HREF="#u_int32_t">u_int32_t</A> ssrc, <A HREF="#u_int64_t">u_int64_t</A> seq)
</LI>
<LI>bool <b><A HREF="#ref19">deriveKey</A></b> (Cipher& cipher, DataBlock& key, unsigned int len, unsigned char label, <A HREF="#u_int64_t">u_int64_t</A> index = 0)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Security and integrity implementation
</p>
<A NAME="RTPSecure"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>RTPSecure</strong> ()
<br></td><td align="right"><h3><strong>RTPSecure</strong></h3></td></tr></table><p></p><p>
Default constructor, builds an inactive implementation
</p>
<A NAME="RTPSecure"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>RTPSecure</strong> (const String& suite)
<br></td><td align="right"><h3><strong>RTPSecure</strong></h3></td></tr></table><p></p><p>
Constructor that creates an active implementation
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>suite</i></TD><TD align="left" valign="top">Cryptographic suite to use by default
</TD></TR>
</TABLE></P>
<A NAME="RTPSecure"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>RTPSecure</strong> (const RTPSecure& other)
<br></td><td align="right"><h3><strong>RTPSecure</strong></h3></td></tr></table><p></p><p>
Constructor that copies the basic crypto lengths
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Security provider to copy parameters from
</TD></TR>
</TABLE></P>
<A NAME="~RTPSecure"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~RTPSecure</strong> ()
<br></td><td align="right"><h3><strong>~RTPSecure</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="owner"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RTPBaseIO* <strong>owner</strong> ()
<br></td><td align="right"><h3><strong>owner</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the owner of this security instance
</p>
<p><b>Returns</b>: Pointer to RTPBaseIO or NULL
</p>
<A NAME="owner"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>owner</strong> (RTPBaseIO* newOwner)
<br></td><td align="right"><h3><strong>owner</strong></h3></td></tr></table><p></p><p>
Set the owner of this security instance
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newOwner</i></TD><TD align="left" valign="top">Pointer to new RTPBaseIO owning this security instance
</TD></TR>
</TABLE></P>
<A NAME="rtpCipher"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Cipher* <strong>rtpCipher</strong> ()
<br></td><td align="right"><h3><strong>rtpCipher</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the current RTP cipher if set
</p>
<p><b>Returns</b>: Pointer to current RTP cipher or NULL
</p>
<A NAME="supported"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>supported</strong> (RTPSession* session = 0)
<br></td><td align="right"><h3><strong>supported</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Check if the systems supports requirements for activating SRTP
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>session</i></TD><TD align="left" valign="top">RTP session to use for cipher checking, NULL to use owner session
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if it looks like SRTP can be activated later
</p>
<A NAME="setup"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>setup</strong> (const String& suite, const String& keyParams, const ObjList* paramList = 0)
<br></td><td align="right"><h3><strong>setup</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Set up the cryptographic parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>suite</i></TD><TD align="left" valign="top">Descriptor of the encryption and authentication algorithms
</TD></TR>
<TR><TD align="left" valign="top"><i>keyParams</i></TD><TD align="left" valign="top">Keying material and related parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>paramList</i></TD><TD align="left" valign="top">Optional session parameters as list of Strings
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the session parameters were applied successfully
</p>
<A NAME="create"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>create</strong> (String& suite, String& keyParams, bool buildMaster = true)
<br></td><td align="right"><h3><strong>create</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create a set of cryptographic parameters
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>suite</i></TD><TD align="left" valign="top">Reference of returned cryptographic suite description
</TD></TR>
<TR><TD align="left" valign="top"><i>keyParams</i></TD><TD align="left" valign="top">Reference to returned keying material
</TD></TR>
<TR><TD align="left" valign="top"><i>buildMaster</i></TD><TD align="left" valign="top">Create random master key and salt if not already set
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if security instance is valid and ready
</p>
<A NAME="init"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>init</strong> ()
<br></td><td align="right"><h3><strong>init</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Initialize security related variables in the RTP session
</p>
<A NAME="rtpEncipher"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpEncipher</strong> (unsigned char* data, int len)
<br></td><td align="right"><h3><strong>rtpEncipher</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called to encipher RTP payload data in-place
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to data block to encipher
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of payload data to be encrypted including any padding
</TD></TR>
</TABLE></P>
<A NAME="rtpAddIntegrity"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>rtpAddIntegrity</strong> (const unsigned char* data, int len, unsigned char* authData)
<br></td><td align="right"><h3><strong>rtpAddIntegrity</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called to add integrity information to the RTP packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to the RTP packet to protect
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of RTP data to be encrypted including header and padding
</TD></TR>
<TR><TD align="left" valign="top"><i>authData</i></TD><TD align="left" valign="top">Address to write the integrity data to
</TD></TR>
</TABLE></P>
<A NAME="rtpDecipher"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>rtpDecipher</strong> (unsigned char* data, int len, const void* secData, <A HREF="#u_int32_t">u_int32_t</A> ssrc, <A HREF="#u_int64_t">u_int64_t</A> seq)
<br></td><td align="right"><h3><strong>rtpDecipher</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called to decipher RTP data in-place
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to data block to decipher
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of data including any padding
</TD></TR>
<TR><TD align="left" valign="top"><i>secData</i></TD><TD align="left" valign="top">Pointer to security data if applicable
</TD></TR>
<TR><TD align="left" valign="top"><i>ssrc</i></TD><TD align="left" valign="top">SSRC of the packet to decipher
</TD></TR>
<TR><TD align="left" valign="top"><i>seq</i></TD><TD align="left" valign="top">Full (48 bit) seqence number of the packet including rollovers
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True is the packet was deciphered correctly or can't tell
</p>
<A NAME="rtpCheckIntegrity"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>rtpCheckIntegrity</strong> (const unsigned char* data, int len, const void* authData, <A HREF="#u_int32_t">u_int32_t</A> ssrc, <A HREF="#u_int64_t">u_int64_t</A> seq)
<br></td><td align="right"><h3><strong>rtpCheckIntegrity</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Method called to check the integrity of the RTP packet
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Pointer to RTP header and data
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of header, data and padding
</TD></TR>
<TR><TD align="left" valign="top"><i>authData</i></TD><TD align="left" valign="top">Pointer to authentication data
</TD></TR>
<TR><TD align="left" valign="top"><i>ssrc</i></TD><TD align="left" valign="top">SSRC of the packet to validate
</TD></TR>
<TR><TD align="left" valign="top"><i>seq</i></TD><TD align="left" valign="top">Full (48 bit) seqence number of the packet including rollovers
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True is the packet passed integrity checks
</p>
<A NAME="deriveKey"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>deriveKey</strong> (Cipher& cipher, DataBlock& key, unsigned int len, unsigned char label, <A HREF="#u_int64_t">u_int64_t</A> index = 0)
<br></td><td align="right"><h3><strong>deriveKey</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Internal method implementing key derivation
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>cipher</i></TD><TD align="left" valign="top">Cipher used for key derivation
</TD></TR>
<TR><TD align="left" valign="top"><i>key</i></TD><TD align="left" valign="top">Reference to derived key output
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Desired length of the key, should be at most cipher block length
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Derived key type
</TD></TR>
<TR><TD align="left" valign="top"><i>index</i></TD><TD align="left" valign="top">Packet index after being divided by KDR
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if success, false if invalid parameters or missing cipher
</p>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
