Intel/AMT/SOAP.pm

package Intel::AMT::SOAP;

# based on amttool from amtterm 1.2 from http://dl.bytesex.org/releases/amtterm/

use strict;
use warnings;
use SOAP::Lite;
#use SOAP::Lite +trace => 'all';
use Data::Dump qw/dump/;

use lib 'lib';

sub soap_url {
        my $amt_host = $ENV{'AMT_HOST'};
        my $amt_port = "16992";
        "http://$amt_host:$amt_port";
}

my $amt_debug = 0;
$amt_debug = $ENV{'AMT_DEBUG'} if defined($ENV{'AMT_DEBUG'});

my $amt_version;

#############################################################################
# data

my @ps = ("S0", "S1", "S2", "S3", "S4", "S5 (soft-off)", "S4/S5", "Off");

# incomplete list
my %pt_status = (
        0x0  =>  "success",
        0x1  =>  "internal error",
        0x3  =>  "invalid pt_mode",
        0xc  =>  "invalid name",
        0xf  =>  "invalid byte_count",
        0x10  =>  "not permitted",
        0x17  =>  "max limit_reached",
        0x18  =>  "invalid auth_type",
        0x1a  =>  "invalid dhcp_mode",
        0x1b  =>  "invalid ip_address",
        0x1c  =>  "invalid domain_name",
        0x20  =>  "invalid provisioning_state",
        0x22  =>  "invalid time",
        0x23  =>  "invalid index",
        0x24  =>  "invalid parameter",
        0x25  =>  "invalid netmask",
        0x26  =>  "flash write_limit_exceeded",
        0x800  =>  "network if_error_base",
        0x801  =>  "unsupported oem_number",
        0x802  =>  "unsupported boot_option",
        0x803  =>  "invalid command",
        0x804  =>  "invalid special_command",
        0x805  =>  "invalid handle",
        0x806  =>  "invalid password",
        0x807  =>  "invalid realm",
        0x808  =>  "storage acl_entry_in_use",
        0x809  =>  "data missing",
        0x80a  =>  "duplicate",
        0x80b  =>  "eventlog frozen",
        0x80c  =>  "pki missing_keys",
        0x80d  =>  "pki generating_keys",
        0x80e  =>  "invalid key",
        0x80f  =>  "invalid cert",
        0x810  =>  "cert key_not_match",
        0x811  =>  "max kerb_domain_reached",
        0x812  =>  "unsupported",
        0x813  =>  "invalid priority",
        0x814  =>  "not found",
        0x815  =>  "invalid credentials",
        0x816  =>  "invalid passphrase",
        0x818  =>  "no association",
);


#############################################################################
# soap setup

my ($nas, $sas, $rcs);

sub SOAP::Transport::HTTP::Client::get_basic_credentials {
        return 'admin' => $ENV{AMT_PASSWORD};
}

sub init() {
        my $proxybase = soap_url;
        my $schemabase = "http://schemas.intel.com/platform/client";

        $nas = SOAP::Lite->new(
                proxy      => "$proxybase/NetworkAdministrationService",
                default_ns => "$schemabase/NetworkAdministration/2004/01");
        $sas = SOAP::Lite->new(
                proxy      => "$proxybase/SecurityAdministrationService",
                default_ns => "$schemabase/SecurityAdministration/2004/01");
        $rcs = SOAP::Lite->new(
                proxy      => "$proxybase/RemoteControlService",
                default_ns => "$schemabase/RemoteControl/2004/01");

        $nas->autotype(0);
        $sas->autotype(0);
        $rcs->autotype(0);

        warn $proxybase;

        $amt_version = $sas->GetCoreVersion()->paramsout;
}

sub _soap {
        my $name = shift;

        my $proxybase = soap_url;
        my $schemabase = "http://schemas.intel.com/platform/client";

        warn "call_soap $proxybase $name ",dump( @_ );

        my $soap = SOAP::Lite->new(
                proxy      => "$proxybase/${name}Service",
                default_ns => "$schemabase/$name/2004/01");

        $soap->autotype(0);

        if ( @_ ) {
                do_soap($soap, $name, @_)
        } else {
                return $soap;
        }
}


#############################################################################
# functions

sub usage() {
        print STDERR <<EOF;

This utility can talk to Intel AMT managed machines.

usage: amttool <hostname> [ <command> ] [ <arg(s)> ]
commands:
   info            - print some machine info (default).
   reset           - reset machine.
   powerup         - turn on machine.
   powerdown       - turn off machine.
   powercycle      - powercycle machine.

AMT 2.5+ only:
   netinfo         - print network config.
   netconf <args>  - configure network (check manpage).

Password is passed via AMT_PASSWORD environment variable.

EOF
}

sub print_result($) {
        my $ret = shift;
        my $rc = $ret->result;
        my $msg;

        if (!defined($rc)) {
                $msg = "soap failure";
warn dump( $ret->faultdetail );
        } elsif (!defined($pt_status{$rc})) {
                $msg = sprintf("unknown pt_status code: 0x%x", $rc);
        } else {
                $msg = "pt_status: " . $pt_status{$rc};
        }
        printf "result: %s\n", $msg;
}

sub print_paramsout($) {
        my $ret = shift;
        my @paramsout = $ret->paramsout;
        print "params: " . join(", ", @paramsout) . "\n";
}

sub print_hash {
        my $hash = shift;
        my $in = shift;
        my $wi = shift;

        foreach my $item (sort keys %{$hash}) {
                if (ref($hash->{$item}) eq "HASH") {
#                       printf "%*s%s\n", $in, "", $item;
                        next;
                }
                printf "%*s%-*s%s\n", $in, "", $wi, $item, $hash->{$item};
        }
}

sub print_hash_ipv4 {
        my $hash = shift;
        my $in = shift;
        my $wi = shift;

        foreach my $item (sort keys %{$hash}) {
                my $addr = sprintf("%d.%d.%d.%d",
                        $hash->{$item} / 256 / 256 / 256,
                        $hash->{$item} / 256 / 256 % 256,
                        $hash->{$item} / 256 % 256,
                        $hash->{$item} % 256);
                printf "%*s%-*s%s\n", $in, "", $wi, $item, $addr;
        }
}

sub do_soap {
        my $soap = shift;
        my $name = shift;
        my @args = @_;
        my $method;

        $method = SOAP::Data->name($name)
                            ->attr( { xmlns => $soap->ns } );

        if ($amt_debug) {
                print "-- \n";
                open XML, "| xmllint --format -";
                print XML $soap->serializer->envelope(method => $method, @_);
                close XML;
                print "-- \n";
        }

        my $ret = $soap->call($method, @args);
        print_result($ret);
        return $ret;
}

sub check_amt_version {
        my $major = shift;
        my $minor = shift;

        $amt_version =~ m/^(\d+).(\d+)/;
        return if $1 > $major;
        return if $1 == $major && $2 >= $minor;
        die "version mismatch (need >= $major.$minor, have $amt_version)";
}

sub print_general_info() {

        printf "AMT version:  %s\n", $amt_version;
        
        my $hostname = $nas->GetHostName()->paramsout;
        my $domainname = $nas->GetDomainName()->paramsout;
        printf "Hostname:     %s.%s\n", $hostname, $domainname;

        my $powerstate = $rcs->GetSystemPowerState()->paramsout;
        printf "Powerstate:   %s\n", $ps [ $powerstate & 0x0f ];
}

sub print_network_info() {
        my $ret;

        $ret = $nas->EnumerateInterfaces();
        my @if = $ret->paramsout;
        foreach my $if (@if) {
                printf "Network Interface %s:\n", $if;
                my $arg = SOAP::Data->name('InterfaceHandle' => $if);
                $ret = $nas->GetInterfaceSettings($arg);
                my $desc = $ret->paramsout;
                print_hash($ret->paramsout, 4, 32);
                print_hash_ipv4($ret->paramsout->{'IPv4Parameters'}, 8, 28);
        }
}

sub ipv4_addr($$) {
        my $name = shift;
        my $ipv4 = shift;

        $ipv4 =~ m/(\d+).(\d+).(\d+).(\d+)/ or die "parse ipv4 address: $ipv4";
        my $num = $1 * 256 * 256 * 256 +
                $2 * 256 * 246 +
                $3 * 256 +
                $4;
        printf STDERR "ipv4 %-24s: %-16s -> %d\n", $name, $ipv4, $num
                if $amt_debug;
        return SOAP::Data->name($name => $num);
}

sub configure_network {
        my $if = shift;
        my $link = shift;
        my $ip = shift;
        my $mask = shift;
        my $gw = shift;
        my $dns1 = shift;
        my $dns2 = shift;

        my $mode;
        my @ifdesc;
        my @ipv4;

        my $method;
        my @args;

        # build argument structs ...
        die "no interface" if !defined($if);
        die "no linkpolicy" if !defined($link);
        if (defined($ip)) {
                $mode = "SEPARATE_MAC_ADDRESS";
                die "no ip mask"     if !defined($mask);
                die "no default gw"  if !defined($gw);
                $dns1 = $gw          if !defined($dns1);
                $dns2 = "0.0.0.0"    if !defined($dns2);
                push (@ipv4, ipv4_addr("LocalAddress", $ip));
                push (@ipv4, ipv4_addr("SubnetMask", $mask));
                push (@ipv4, ipv4_addr("DefaultGatewayAddress", $gw));
                push (@ipv4, ipv4_addr("PrimaryDnsAddress", $dns1));
                push (@ipv4, ipv4_addr("SecondaryDnsAddress", $dns2));
        } else {
                $mode = "SHARED_MAC_ADDRESS";
                # no ip info -- use DHCP
        }

        push (@ifdesc, SOAP::Data->name("InterfaceMode" => $mode));
        push (@ifdesc, SOAP::Data->name("LinkPolicy" => $link));
        push (@ifdesc, SOAP::Data->name("IPv4Parameters" => 
                \SOAP::Data->value(@ipv4)))
                        if @ipv4;

        push (@args, SOAP::Data->name("InterfaceHandle" => $if));
        push (@args, SOAP::Data->name("InterfaceDescriptor" =>
                \SOAP::Data->value(@ifdesc)));

        # perform call
        do_soap($nas, "SetInterfaceSettings", @args);
}


sub command {
        my ($amt_command,$amt_arg) = @_;

        init;

        if ($amt_command eq "info") {
                print_general_info;
        } elsif ($amt_command eq "netinfo") {
                check_amt_version(2,5);
                print_network_info;
        } elsif ($amt_command eq "netconf") {
                check_amt_version(2,5);
                configure_network(@_);
        } elsif ($amt_command =~ m/^(reset|powerup|powerdown|powercycle)$/) {
                remote_control($amt_command, $amt_arg);
        } else {
                print "unknown command: $amt_command\n";
        }

}

warn 'loaded';

1;
1	dpavlin	2	package Intel::AMT::SOAP;
2
3			# based on amttool from amtterm 1.2 from http://dl.bytesex.org/releases/amtterm/
4
5			use strict;
6			use warnings;
7			use SOAP::Lite;
8			#use SOAP::Lite +trace => 'all';
9	dpavlin	5	use Data::Dump qw/dump/;
10	dpavlin	2
11	dpavlin	5	use lib 'lib';
12
13	dpavlin	16	sub soap_url {
14			my $amt_host = $ENV{'AMT_HOST'};
15			my $amt_port = "16992";
16			"http://$amt_host:$amt_port";
17			}
18
19	dpavlin	2	my $amt_debug = 0;
20			$amt_debug = $ENV{'AMT_DEBUG'} if defined($ENV{'AMT_DEBUG'});
21
22			my $amt_version;
23
24			#############################################################################
25			# data
26
27			my @ps = ("S0", "S1", "S2", "S3", "S4", "S5 (soft-off)", "S4/S5", "Off");
28
29			# incomplete list
30			my %pt_status = (
31			0x0 => "success",
32			0x1 => "internal error",
33			0x3 => "invalid pt_mode",
34			0xc => "invalid name",
35			0xf => "invalid byte_count",
36			0x10 => "not permitted",
37			0x17 => "max limit_reached",
38			0x18 => "invalid auth_type",
39			0x1a => "invalid dhcp_mode",
40			0x1b => "invalid ip_address",
41			0x1c => "invalid domain_name",
42			0x20 => "invalid provisioning_state",
43			0x22 => "invalid time",
44			0x23 => "invalid index",
45			0x24 => "invalid parameter",
46			0x25 => "invalid netmask",
47			0x26 => "flash write_limit_exceeded",
48			0x800 => "network if_error_base",
49			0x801 => "unsupported oem_number",
50			0x802 => "unsupported boot_option",
51			0x803 => "invalid command",
52			0x804 => "invalid special_command",
53			0x805 => "invalid handle",
54			0x806 => "invalid password",
55			0x807 => "invalid realm",
56			0x808 => "storage acl_entry_in_use",
57			0x809 => "data missing",
58			0x80a => "duplicate",
59			0x80b => "eventlog frozen",
60			0x80c => "pki missing_keys",
61			0x80d => "pki generating_keys",
62			0x80e => "invalid key",
63			0x80f => "invalid cert",
64			0x810 => "cert key_not_match",
65			0x811 => "max kerb_domain_reached",
66			0x812 => "unsupported",
67			0x813 => "invalid priority",
68			0x814 => "not found",
69			0x815 => "invalid credentials",
70			0x816 => "invalid passphrase",
71			0x818 => "no association",
72			);
73
74
75			#############################################################################
76			# soap setup
77
78			my ($nas, $sas, $rcs);
79
80			sub SOAP::Transport::HTTP::Client::get_basic_credentials {
81	dpavlin	16	return 'admin' => $ENV{AMT_PASSWORD};
82	dpavlin	2	}
83
84	dpavlin	5	sub init() {
85	dpavlin	16	my $proxybase = soap_url;
86	dpavlin	2	my $schemabase = "http://schemas.intel.com/platform/client";
87
88			$nas = SOAP::Lite->new(
89			proxy => "$proxybase/NetworkAdministrationService",
90			default_ns => "$schemabase/NetworkAdministration/2004/01");
91			$sas = SOAP::Lite->new(
92			proxy => "$proxybase/SecurityAdministrationService",
93			default_ns => "$schemabase/SecurityAdministration/2004/01");
94			$rcs = SOAP::Lite->new(
95			proxy => "$proxybase/RemoteControlService",
96			default_ns => "$schemabase/RemoteControl/2004/01");
97
98			$nas->autotype(0);
99			$sas->autotype(0);
100			$rcs->autotype(0);
101
102	dpavlin	5	warn $proxybase;
103
104	dpavlin	2	$amt_version = $sas->GetCoreVersion()->paramsout;
105			}
106
107	dpavlin	6	sub _soap {
108			my $name = shift;
109	dpavlin	2
110	dpavlin	16	my $proxybase = soap_url;
111	dpavlin	6	my $schemabase = "http://schemas.intel.com/platform/client";
112
113			warn "call_soap $proxybase $name ",dump( @_ );
114
115			my $soap = SOAP::Lite->new(
116			proxy => "$proxybase/${name}Service",
117			default_ns => "$schemabase/$name/2004/01");
118
119			$soap->autotype(0);
120
121			if ( @_ ) {
122	dpavlin	7	do_soap($soap, $name, @_)
123	dpavlin	6	} else {
124			return $soap;
125			}
126			}
127
128
129	dpavlin	2	#############################################################################
130			# functions
131
132			sub usage() {
133			print STDERR <<EOF;
134
135			This utility can talk to Intel AMT managed machines.
136
137			usage: amttool <hostname> [ <command> ] [ <arg(s)> ]
138			commands:
139			info - print some machine info (default).
140			reset - reset machine.
141			powerup - turn on machine.
142			powerdown - turn off machine.
143			powercycle - powercycle machine.
144
145			AMT 2.5+ only:
146			netinfo - print network config.
147			netconf <args> - configure network (check manpage).
148
149			Password is passed via AMT_PASSWORD environment variable.
150
151			EOF
152			}
153
154			sub print_result($) {
155			my $ret = shift;
156			my $rc = $ret->result;
157			my $msg;
158
159			if (!defined($rc)) {
160			$msg = "soap failure";
161	dpavlin	5	warn dump( $ret->faultdetail );
162	dpavlin	2	} elsif (!defined($pt_status{$rc})) {
163			$msg = sprintf("unknown pt_status code: 0x%x", $rc);
164			} else {
165			$msg = "pt_status: " . $pt_status{$rc};
166			}
167			printf "result: %s\n", $msg;
168			}
169
170			sub print_paramsout($) {
171			my $ret = shift;
172			my @paramsout = $ret->paramsout;
173			print "params: " . join(", ", @paramsout) . "\n";
174			}
175
176			sub print_hash {
177			my $hash = shift;
178			my $in = shift;
179			my $wi = shift;
180
181			foreach my $item (sort keys %{$hash}) {
182			if (ref($hash->{$item}) eq "HASH") {
183			# printf "%*s%s\n", $in, "", $item;
184			next;
185			}
186			printf "%s%-s%s\n", $in, "", $wi, $item, $hash->{$item};
187			}
188			}
189
190			sub print_hash_ipv4 {
191			my $hash = shift;
192			my $in = shift;
193			my $wi = shift;
194
195			foreach my $item (sort keys %{$hash}) {
196			my $addr = sprintf("%d.%d.%d.%d",
197			$hash->{$item} / 256 / 256 / 256,
198			$hash->{$item} / 256 / 256 % 256,
199			$hash->{$item} / 256 % 256,
200			$hash->{$item} % 256);
201			printf "%s%-s%s\n", $in, "", $wi, $item, $addr;
202			}
203			}
204
205			sub do_soap {
206			my $soap = shift;
207			my $name = shift;
208			my @args = @_;
209			my $method;
210
211			$method = SOAP::Data->name($name)
212			->attr( { xmlns => $soap->ns } );
213
214			if ($amt_debug) {
215			print "-- \n";
216			open XML, "\| xmllint --format -";
217			print XML $soap->serializer->envelope(method => $method, @_);
218			close XML;
219			print "-- \n";
220			}
221
222			my $ret = $soap->call($method, @args);
223			print_result($ret);
224			return $ret;
225			}
226
227			sub check_amt_version {
228			my $major = shift;
229			my $minor = shift;
230
231			$amt_version =~ m/^(\d+).(\d+)/;
232			return if $1 > $major;
233			return if $1 == $major && $2 >= $minor;
234			die "version mismatch (need >= $major.$minor, have $amt_version)";
235			}
236
237			sub print_general_info() {
238
239			printf "AMT version: %s\n", $amt_version;
240
241			my $hostname = $nas->GetHostName()->paramsout;
242			my $domainname = $nas->GetDomainName()->paramsout;
243			printf "Hostname: %s.%s\n", $hostname, $domainname;
244
245			my $powerstate = $rcs->GetSystemPowerState()->paramsout;
246			printf "Powerstate: %s\n", $ps [ $powerstate & 0x0f ];
247			}
248	dpavlin	5
249	dpavlin	2	sub print_network_info() {
250			my $ret;
251
252			$ret = $nas->EnumerateInterfaces();
253			my @if = $ret->paramsout;
254			foreach my $if (@if) {
255			printf "Network Interface %s:\n", $if;
256			my $arg = SOAP::Data->name('InterfaceHandle' => $if);
257			$ret = $nas->GetInterfaceSettings($arg);
258			my $desc = $ret->paramsout;
259			print_hash($ret->paramsout, 4, 32);
260			print_hash_ipv4($ret->paramsout->{'IPv4Parameters'}, 8, 28);
261			}
262			}
263
264			sub ipv4_addr($$) {
265			my $name = shift;
266			my $ipv4 = shift;
267
268			$ipv4 =~ m/(\d+).(\d+).(\d+).(\d+)/ or die "parse ipv4 address: $ipv4";
269			my $num = $1 * 256 * 256 * 256 +
270			$2 * 256 * 246 +
271			$3 * 256 +
272			$4;
273			printf STDERR "ipv4 %-24s: %-16s -> %d\n", $name, $ipv4, $num
274			if $amt_debug;
275			return SOAP::Data->name($name => $num);
276			}
277
278			sub configure_network {
279			my $if = shift;
280			my $link = shift;
281			my $ip = shift;
282			my $mask = shift;
283			my $gw = shift;
284			my $dns1 = shift;
285			my $dns2 = shift;
286
287			my $mode;
288			my @ifdesc;
289			my @ipv4;
290
291			my $method;
292			my @args;
293
294			# build argument structs ...
295			die "no interface" if !defined($if);
296			die "no linkpolicy" if !defined($link);
297			if (defined($ip)) {
298			$mode = "SEPARATE_MAC_ADDRESS";
299			die "no ip mask" if !defined($mask);
300			die "no default gw" if !defined($gw);
301			$dns1 = $gw if !defined($dns1);
302			$dns2 = "0.0.0.0" if !defined($dns2);
303			push (@ipv4, ipv4_addr("LocalAddress", $ip));
304			push (@ipv4, ipv4_addr("SubnetMask", $mask));
305			push (@ipv4, ipv4_addr("DefaultGatewayAddress", $gw));
306			push (@ipv4, ipv4_addr("PrimaryDnsAddress", $dns1));
307			push (@ipv4, ipv4_addr("SecondaryDnsAddress", $dns2));
308			} else {
309			$mode = "SHARED_MAC_ADDRESS";
310			# no ip info -- use DHCP
311			}
312
313			push (@ifdesc, SOAP::Data->name("InterfaceMode" => $mode));
314			push (@ifdesc, SOAP::Data->name("LinkPolicy" => $link));
315			push (@ifdesc, SOAP::Data->name("IPv4Parameters" =>
316			\SOAP::Data->value(@ipv4)))
317			if @ipv4;
318
319			push (@args, SOAP::Data->name("InterfaceHandle" => $if));
320			push (@args, SOAP::Data->name("InterfaceDescriptor" =>
321			\SOAP::Data->value(@ifdesc)));
322
323			# perform call
324			do_soap($nas, "SetInterfaceSettings", @args);
325			}
326
327
328			sub command {
329			my ($amt_command,$amt_arg) = @_;
330
331	dpavlin	5	init;
332	dpavlin	2
333			if ($amt_command eq "info") {
334			print_general_info;
335			} elsif ($amt_command eq "netinfo") {
336			check_amt_version(2,5);
337			print_network_info;
338			} elsif ($amt_command eq "netconf") {
339			check_amt_version(2,5);
340	dpavlin	5	configure_network(@_);
341	dpavlin	2	} elsif ($amt_command =~ m/^(reset\|powerup\|powerdown\|powercycle)$/) {
342			remote_control($amt_command, $amt_arg);
343			} else {
344			print "unknown command: $amt_command\n";
345			}
346
347			}
348
349			warn 'loaded';
350
351			1;