mock-igd 0.1.0

A mock UPnP Internet Gateway Device (IGD) server for testing
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

//! XML/SOAP response templates.

use super::SuccessResponse;

/// SOAP envelope template.
const SOAP_ENVELOPE_START: &str = r#"<?xml version="1.0"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<s:Body>"#;

const SOAP_ENVELOPE_END: &str = r#"</s:Body>
</s:Envelope>"#;

/// Generate a SOAP fault response.
pub(crate) fn generate_soap_fault(code: u16, description: &str) -> String {
    format!(
        r#"<?xml version="1.0"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<s:Body>
<s:Fault>
<faultcode>s:Client</faultcode>
<faultstring>UPnPError</faultstring>
<detail>
<UPnPError xmlns="urn:schemas-upnp-org:control-1-0">
<errorCode>{code}</errorCode>
<errorDescription>{description}</errorDescription>
</UPnPError>
</detail>
</s:Fault>
</s:Body>
</s:Envelope>"#
    )
}

/// Generate a successful SOAP response for the given action.
pub(crate) fn generate_success_response(action_name: &str, data: &SuccessResponse) -> String {
    let body = match action_name {
        "GetExternalIPAddress" => generate_get_external_ip_response(data),
        "GetStatusInfo" => generate_get_status_info_response(data),
        "AddPortMapping" => generate_add_port_mapping_response(),
        "DeletePortMapping" => generate_delete_port_mapping_response(),
        "GetGenericPortMappingEntry" => generate_get_port_mapping_entry_response(data),
        "GetSpecificPortMappingEntry" => generate_get_port_mapping_entry_response(data),
        "GetCommonLinkProperties" => generate_get_common_link_properties_response(data),
        "GetTotalBytesReceived" => generate_get_total_bytes_received_response(data),
        "GetTotalBytesSent" => generate_get_total_bytes_sent_response(data),
        _ => format!(
            "<u:{action_name}Response xmlns:u=\"urn:schemas-upnp-org:service:WANIPConnection:1\"></u:{action_name}Response>"
        ),
    };

    format!("{SOAP_ENVELOPE_START}\n{body}\n{SOAP_ENVELOPE_END}")
}

fn generate_get_external_ip_response(data: &SuccessResponse) -> String {
    let ip = data
        .external_ip
        .map(|ip| ip.to_string())
        .unwrap_or_default();
    format!(
        r#"<u:GetExternalIPAddressResponse xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1">
<NewExternalIPAddress>{ip}</NewExternalIPAddress>
</u:GetExternalIPAddressResponse>"#
    )
}

fn generate_get_status_info_response(data: &SuccessResponse) -> String {
    let connection_status = data.connection_status.as_deref().unwrap_or("Connected");
    let last_connection_error = data.last_connection_error.as_deref().unwrap_or("ERROR_NONE");
    let uptime = data.uptime.unwrap_or(0);
    format!(
        r#"<u:GetStatusInfoResponse xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1">
<NewConnectionStatus>{connection_status}</NewConnectionStatus>
<NewLastConnectionError>{last_connection_error}</NewLastConnectionError>
<NewUptime>{uptime}</NewUptime>
</u:GetStatusInfoResponse>"#
    )
}

fn generate_add_port_mapping_response() -> String {
    r#"<u:AddPortMappingResponse xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1">
</u:AddPortMappingResponse>"#
        .to_string()
}

fn generate_delete_port_mapping_response() -> String {
    r#"<u:DeletePortMappingResponse xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1">
</u:DeletePortMappingResponse>"#
        .to_string()
}

fn generate_get_port_mapping_entry_response(data: &SuccessResponse) -> String {
    let remote_host = data.remote_host.as_deref().unwrap_or("");
    let external_port = data.external_port.unwrap_or(0);
    let protocol = data.protocol.as_deref().unwrap_or("TCP");
    let internal_port = data.internal_port.unwrap_or(0);
    let internal_client = data.internal_client.as_deref().unwrap_or("");
    let enabled = if data.enabled.unwrap_or(true) { "1" } else { "0" };
    let description = data.description.as_deref().unwrap_or("");
    let lease_duration = data.lease_duration.unwrap_or(0);

    format!(
        r#"<u:GetGenericPortMappingEntryResponse xmlns:u="urn:schemas-upnp-org:service:WANIPConnection:1">
<NewRemoteHost>{remote_host}</NewRemoteHost>
<NewExternalPort>{external_port}</NewExternalPort>
<NewProtocol>{protocol}</NewProtocol>
<NewInternalPort>{internal_port}</NewInternalPort>
<NewInternalClient>{internal_client}</NewInternalClient>
<NewEnabled>{enabled}</NewEnabled>
<NewPortMappingDescription>{description}</NewPortMappingDescription>
<NewLeaseDuration>{lease_duration}</NewLeaseDuration>
</u:GetGenericPortMappingEntryResponse>"#
    )
}

fn generate_get_common_link_properties_response(data: &SuccessResponse) -> String {
    let wan_access_type = data.wan_access_type.as_deref().unwrap_or("Cable");
    let upstream = data.layer1_upstream_max_bit_rate.unwrap_or(10000000);
    let downstream = data.layer1_downstream_max_bit_rate.unwrap_or(100000000);
    let status = data.physical_link_status.as_deref().unwrap_or("Up");

    format!(
        r#"<u:GetCommonLinkPropertiesResponse xmlns:u="urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1">
<NewWANAccessType>{wan_access_type}</NewWANAccessType>
<NewLayer1UpstreamMaxBitRate>{upstream}</NewLayer1UpstreamMaxBitRate>
<NewLayer1DownstreamMaxBitRate>{downstream}</NewLayer1DownstreamMaxBitRate>
<NewPhysicalLinkStatus>{status}</NewPhysicalLinkStatus>
</u:GetCommonLinkPropertiesResponse>"#
    )
}

fn generate_get_total_bytes_received_response(data: &SuccessResponse) -> String {
    let bytes = data.total_bytes.unwrap_or(0);
    format!(
        r#"<u:GetTotalBytesReceivedResponse xmlns:u="urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1">
<NewTotalBytesReceived>{bytes}</NewTotalBytesReceived>
</u:GetTotalBytesReceivedResponse>"#
    )
}

fn generate_get_total_bytes_sent_response(data: &SuccessResponse) -> String {
    let bytes = data.total_bytes.unwrap_or(0);
    format!(
        r#"<u:GetTotalBytesSentResponse xmlns:u="urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1">
<NewTotalBytesSent>{bytes}</NewTotalBytesSent>
</u:GetTotalBytesSentResponse>"#
    )
}