rustpbx 0.4.3

A SIP PBX implementation in Rust
Documentation
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
use crate::call::SipUser;
use crate::config::{ProxyConfig, RtpConfig};
use crate::proxy::active_call_registry::ActiveProxyCallRegistry;
use crate::proxy::server::SipServerInner;
use crate::proxy::user::MemoryUserBackend;
use crate::proxy::{
    data::ProxyDataContext,
    locator::{Locator, MemoryLocator},
};
use rsipstack::dialog::dialog_layer::DialogLayer;
use rsipstack::sip::Header;
use rsipstack::sip::services::DigestGenerator;
use rsipstack::sip::{HostWithPort, prelude::*};
use rsipstack::transaction::endpoint::EndpointInner;
use rsipstack::transaction::key::{TransactionKey, TransactionRole};
use rsipstack::transaction::random_text;
use rsipstack::transaction::transaction::Transaction;
use rsipstack::transport::SipAddr;
use rsipstack::transport::channel::ChannelConnection;
use std::sync::Arc;
use std::sync::atomic::AtomicUsize;
use std::time::Duration;
use tokio::sync::mpsc;
use tokio_util::sync::CancellationToken;

/// Creates a test SIP server with a memory user backend and locator
pub async fn create_test_server() -> (Arc<SipServerInner>, Arc<ProxyConfig>) {
    create_test_server_with_config(ProxyConfig::default()).await
}

/// Creates a test SIP server with custom config
pub async fn create_test_server_with_config(
    mut config: ProxyConfig,
) -> (Arc<SipServerInner>, Arc<ProxyConfig>) {
    // Add rustpbx.com to the allowed realms for testing
    if config.realms.is_none() {
        config.realms = Some(vec![]);
    }
    config
        .realms
        .as_mut()
        .unwrap()
        .push("rustpbx.com".to_string());

    let user_backend = Box::new(MemoryUserBackend::new(None));
    let locator = Arc::new(Box::new(MemoryLocator::new()) as Box<dyn Locator>);
    let config = Arc::new(config);

    let endpoint = rsipstack::EndpointBuilder::new().build();
    // Add a mock transport to the endpoint so it can send out-of-dialog requests in tests
    let (tx_chan, _rx_chan) = tokio::sync::mpsc::unbounded_channel();
    let mock_addr = SipAddr {
        r#type: Some(rsipstack::sip::Transport::Udp),
        addr: rsipstack::sip::HostWithPort {
            host: "127.0.0.1".parse().unwrap(),
            port: Some(5060.into()),
        },
    };
    let connection = ChannelConnection::create_connection(_rx_chan, tx_chan, mock_addr, None)
        .await
        .expect("failed to create channel connection");
    endpoint
        .inner
        .transport_layer
        .add_transport(connection.into());

    let dialog_layer = Arc::new(DialogLayer::new(endpoint.inner.clone()));
    // Create server inner directly
    let data_context = Arc::new(
        ProxyDataContext::new(config.clone(), None)
            .await
            .expect("failed to init proxy data context for tests"),
    );

    let (locator_events_tx, _) = tokio::sync::broadcast::channel(100);

    let server_inner = Arc::new(SipServerInner {
        rtp_config: RtpConfig::default(),
        proxy_config: config.clone(),
        cancel_token: CancellationToken::new(),
        data_context,
        database: None,
        user_backend,
        auth_backend: Vec::new(),
        call_router: None,
        locator,
        callrecord_sender: None,
        endpoint,
        dialog_layer,
        dialplan_inspectors: Vec::new(),
        create_route_invite: None,
        ignore_out_of_dialog_request: true,
        locator_events: Some(locator_events_tx),
        sip_flow: None,
        active_call_registry: Arc::new(ActiveProxyCallRegistry::new()),
        frequency_limiter: None,
        call_record_hooks: Arc::new(Vec::new()),
        runnings_tx: Arc::new(AtomicUsize::new(0)),
        storage: None,
        presence_manager: Arc::new(crate::proxy::presence::PresenceManager::new(None)),
        addon_registry: None,
        rwi_gateway: None,
        tls_listener: None,
        queue_manager: Arc::new(crate::call::runtime::QueueManager::new()),
        conference_manager: Arc::new(crate::call::runtime::ConferenceManager::new()),
        agent_registry: None,
        transfer_notify_subscribers: Arc::new(tokio::sync::Mutex::new(Vec::new())),
        cluster_event_hub: None,
        cluster_peer_ips: vec![],
    });

    // Add test users
    let enabled_user = SipUser {
        id: 1,
        username: "alice".to_string(),
        password: Some("password".to_string()),
        enabled: true,
        realm: Some("rustpbx.com".to_string()),
        ..Default::default()
    };

    let disabled_user = SipUser {
        id: 2,
        username: "bob".to_string(),
        password: Some("password".to_string()),
        enabled: false,
        realm: Some("rustpbx.com".to_string()),
        ..Default::default()
    };

    server_inner
        .user_backend
        .create_user(enabled_user)
        .await
        .unwrap();
    server_inner
        .user_backend
        .create_user(disabled_user)
        .await
        .unwrap();

    (server_inner, config)
}

/// Creates a basic SIP transaction for testing
pub async fn create_transaction(
    request: rsipstack::sip::Request,
) -> (Transaction, Arc<EndpointInner>) {
    let mock_addr = SipAddr {
        r#type: Some(rsipstack::sip::Transport::Udp),
        addr: HostWithPort {
            host: "127.0.0.1".parse().unwrap(),
            port: Some(5060.into()),
        },
    };
    let (tx, rx) = mpsc::unbounded_channel();
    let connection = ChannelConnection::create_connection(rx, tx, mock_addr, None)
        .await
        .expect("failed to create channel connection");
    let transport_layer = rsipstack::transport::TransportLayer::new(CancellationToken::new());
    let sip_conn: rsipstack::transport::SipConnection = connection.into();
    transport_layer.add_transport(sip_conn.clone());

    let endpoint_inner = EndpointInner::new(
        "RustPBX Test".to_string(),
        transport_layer,
        CancellationToken::new(),
        Some(Duration::from_millis(20)),
        vec![
            rsipstack::sip::Method::Invite,
            rsipstack::sip::Method::Register,
        ],
        None,
        None,
        None,
        None,
    );

    let key = TransactionKey::from_request(&request, TransactionRole::Server).unwrap();
    let tx = Transaction::new_server(key, request, endpoint_inner.clone(), Some(sip_conn));

    (tx, endpoint_inner)
}

pub fn create_test_request(
    method: rsipstack::sip::Method,
    username: &str,
    password: Option<&str>,
    realm: &str,
    expires: Option<u32>,
) -> rsipstack::sip::Request {
    let host_with_port = rsipstack::sip::HostWithPort {
        host: realm.parse().unwrap(),
        port: Some(5060.into()),
    };

    let uri = rsipstack::sip::Uri {
        scheme: Some(rsipstack::sip::Scheme::Sip),
        auth: Some(rsipstack::sip::Auth {
            user: username.to_string(),
            password: None,
        }),
        host_with_port: host_with_port.clone(),
        params: vec![],
        headers: vec![],
    };

    let from = rsipstack::sip::typed::From {
        display_name: None,
        uri: uri.clone(),
        params: vec![rsipstack::sip::Param::Tag(rsipstack::sip::param::Tag::new(
            random_text(8),
        ))],
    };

    let to = rsipstack::sip::typed::To {
        display_name: None,
        uri: uri.clone(),
        params: vec![],
    };

    let via = rsipstack::sip::headers::Via::new(format!(
        "SIP/2.0/UDP {}:5060;branch=z9hG4bK{}",
        realm,
        random_text(8)
    ));

    let call_id = rsipstack::sip::headers::CallId::new(random_text(16));
    let cseq = rsipstack::sip::headers::typed::CSeq { seq: 1u32, method };

    // Create contact with the same user and host
    let contact_uri = rsipstack::sip::Uri {
        scheme: Some(rsipstack::sip::Scheme::Sip),
        auth: Some(rsipstack::sip::Auth {
            user: username.to_string(),
            password: password.map(|p| p.to_string()),
        }),
        host_with_port: host_with_port.clone(),
        params: vec![],
        headers: vec![],
    };

    let contact = rsipstack::sip::typed::Contact {
        display_name: None,
        uri: contact_uri,
        params: vec![],
    };

    let mut headers = vec![
        from.into(),
        to.into(),
        via.into(),
        call_id.into(),
        cseq.into(),
        contact.into(),
    ];

    // Add expires header if provided
    if let Some(exp) = expires {
        headers.push(Header::Expires(exp.into()));
    }
    if let Some(password) = password {
        let demo_nonce = "demo_nonce";
        let digest = DigestGenerator {
            username,
            password,
            algorithm: rsipstack::sip::headers::auth::Algorithm::Md5,
            nonce: demo_nonce,
            method: &method,
            uri: &uri,
            realm,
            qop: None,
        };

        let auth_header = rsipstack::sip::headers::Authorization::new(format!(
            "Digest username=\"{}\", realm=\"{}\", nonce=\"{}\", uri=\"{}\", response=\"{}\", algorithm=MD5",
            username,
            realm,
            demo_nonce,
            uri,
            digest.compute()
        ));
        headers.push(auth_header.into());
    }

    rsipstack::sip::Request {
        method,
        uri: uri.clone(),
        version: rsipstack::sip::Version::V2,
        headers: headers.into(),
        body: vec![],
    }
}
/// Creates a test REGISTER request
pub fn create_register_request(
    username: &str,
    realm: &str,
    expires: Option<u32>,
) -> rsipstack::sip::Request {
    create_test_request(
        rsipstack::sip::Method::Register,
        username,
        None,
        realm,
        expires,
    )
}

/// Creates a test request with proper authentication
pub fn create_auth_request(
    method: rsipstack::sip::Method,
    username: &str,
    realm: &str,
    password: &str,
) -> rsipstack::sip::Request {
    create_test_request(method, username, Some(password), realm, None)
}

/// Creates a test request with specific source IP (for acl module tests)
pub fn create_acl_request(
    method: rsipstack::sip::Method,
    username: &str,
    realm: &str,
) -> rsipstack::sip::Request {
    create_test_request(method, username, None, realm, None)
}

/// Creates a test request with proper proxy authentication
pub fn create_proxy_auth_request_with_nonce(
    method: rsipstack::sip::Method,
    username: &str,
    realm: &str,
    password: Option<&str>,
    nonce: &str,
) -> rsipstack::sip::Request {
    let host_with_port = rsipstack::sip::HostWithPort {
        host: realm.parse().unwrap(),
        port: Some(5060.into()),
    };

    let uri = rsipstack::sip::Uri {
        scheme: Some(rsipstack::sip::Scheme::Sip),
        auth: Some(rsipstack::sip::Auth {
            user: username.to_string(),
            password: None,
        }),
        host_with_port: host_with_port.clone(),
        params: vec![],
        headers: vec![],
    };

    let from = rsipstack::sip::typed::From {
        display_name: None,
        uri: uri.clone(),
        params: vec![rsipstack::sip::Param::Tag(rsipstack::sip::param::Tag::new(
            random_text(8),
        ))],
    };

    let to = rsipstack::sip::typed::To {
        display_name: None,
        uri: uri.clone(),
        params: vec![],
    };

    let via = rsipstack::sip::headers::Via::new(format!(
        "SIP/2.0/UDP {}:5060;branch=z9hG4bK{}",
        realm,
        random_text(8)
    ));

    let call_id = rsipstack::sip::headers::CallId::new(random_text(16));
    let cseq = rsipstack::sip::headers::typed::CSeq { seq: 1u32, method };

    // Create contact with the same user and host
    let contact_uri = rsipstack::sip::Uri {
        scheme: Some(rsipstack::sip::Scheme::Sip),
        auth: Some(rsipstack::sip::Auth {
            user: username.to_string(),
            password: password.map(|p| p.to_string()),
        }),
        host_with_port: host_with_port.clone(),
        params: vec![],
        headers: vec![],
    };

    let contact = rsipstack::sip::typed::Contact {
        display_name: None,
        uri: contact_uri,
        params: vec![],
    };

    let mut headers = vec![
        from.into(),
        to.into(),
        via.into(),
        call_id.into(),
        cseq.into(),
        contact.into(),
    ];

    // Add Proxy-Authorization header if password is provided
    if let Some(password) = password {
        let digest = DigestGenerator {
            username,
            password,
            algorithm: rsipstack::sip::headers::auth::Algorithm::Md5,
            nonce,
            method: &method,
            uri: &uri,
            realm,
            qop: None,
        };

        let proxy_auth_header = rsipstack::sip::headers::ProxyAuthorization::new(format!(
            "Digest username=\"{}\", realm=\"{}\", nonce=\"{}\", uri=\"{}\", response=\"{}\", algorithm=MD5",
            username,
            realm,
            nonce,
            uri,
            digest.compute()
        ));
        headers.push(proxy_auth_header.into());
    }

    rsipstack::sip::Request {
        method,
        uri: uri.clone(),
        version: rsipstack::sip::Version::V2,
        headers: headers.into(),
        body: vec![],
    }
}

/// Extracts nonce from Proxy-Authenticate header
pub fn extract_nonce_from_proxy_authenticate(
    response: &rsipstack::sip::Response,
) -> Option<String> {
    for header in response.headers().iter() {
        if let Header::ProxyAuthenticate(proxy_auth) = header {
            let auth_str = proxy_auth.value();
            // Parse the Digest authentication string to extract nonce
            for part in auth_str.split(',') {
                let part = part.trim();
                if part.starts_with("nonce=") {
                    let nonce = part.strip_prefix("nonce=").unwrap().trim_matches('"');
                    return Some(nonce.to_string());
                }
            }
        }
    }
    None
}