view release on metacpan or  search on metacpan

lib/Net/Wireless/802_11/AP.pm  view on Meta::CPAN

    #get the bssid
    my $bssid=$foo->getKey( 'bssid' );
    if( defined($bssid) ){
        print 'BSSID='.$bssid."\n";
    }else{
        print "No BSSID set.\n";
    }

=head1 METHODS

=head2 new

This initiates the object.

One arguement is required and it is the a hash reference to initiate
the object with.

The hash reference has one required value and that is 'ssid'. This is
SSID of the base station in question.

The others may be any valid key for a configured AP in wpa_supplicant.conf.
For more information, please see wpa_supplicant.conf(5).

There is one break from this and this is the key 'networkID'. This represents the
numeric ID used for with wpa_cli to reference that configured AP.

    my $new=$foo=Net::Wireless::802_11::AP->new( { ssid=>'"foo"' } );

=cut

sub new{
	my %args;
	if(defined($_[1])){
		%args= %{$_[1]};
	}
	
	my $self={
		perror=>undef,
		error=>undef,
		errorString=>'',
		ssid=>undef,
		scan_ssid=>undef,
		bssid=>undef,
		priority=>undef,
		mode=>undef,
		proto=>undef,
		key_mgmt=>undef,
		auth_alg=>undef,
		pairwise=>undef,
		group=>undef,
		psk=>undef,
		eapol_flags=>undef,
		eap=>undef,
		identity=>undef,
		anonymous_identity=>undef,
		mixed_cell=>undef,
		password=>undef,
		ca_cert=>undef,
		client_cert=>undef,
		private_key=>undef,
		private_key_passwd=>undef,
		dh_file=>undef,
		subject_match=>undef,
		phase1=>undef,
		phase2=>undef,
		ca_cert2=>undef,
		client_cert2=>undef,
		private_key2=>undef,
		private_key2_passwd=>undef,
		dh_file2=>undef,
		subject_match2=>undef,
		eappsk=>undef,
		nai=>undef,
		server_nai=>undef,
		pac_file=>undef,
		eap_workaround=>undef,
		networkID=>undef,
		wep_tx_keyidx=>undef,
		wep_key0=>undef,
		wep_key1=>undef,
		wep_key2=>undef,
		wep_key4=>undef,
		valid=>{
			ssid=>1,
			scan_ssid=>1,
			bssid=>1,
			priority=>1,
			mode=>1,
			proto=>1,
			key_mgmt=>1,
			auth_alg=>1,
			pairwise=>1,
			group=>1,
			psk=>1,
			eapol_flags=>1,
			eap=>1,
			identity=>1,
			anonymous_identity=>1,
			mixed_cell=>1,
			password=>1,
			ca_cert=>1,
			client_cert=>1,
			private_key=>1,
			private_key_passwd=>1,
			dh_file=>1,
			subject_match=>1,
			phase1=>1,
			phase2=>1,
			ca_cert2=>1,
			client_cert2=>1,
			private_key2=>1,
			private_key2_passwd=>1,
			dh_file2=>1,
			subject_match2=>1,
			eappsk=>1,
			nai=>1,
			server_nai=>1,
			pac_file=>1,
			eap_workaround=>1,
			networkID=>1,
			wep_tx_keyidx=>1,
			wep_key0=>1,
			wep_key1=>1,
			wep_key2=>1,
			wep_key4=>1,
		},
		wpaKeys=>{
			ssid=>1,
			scan_ssid=>1,
			bssid=>1,
			priority=>1,
			mode=>1,
			proto=>1,
			key_mgmt=>1,
			auth_alg=>1,
			pairwise=>1,
			group=>1,
			psk=>1,
			eapol_flags=>1,
			eap=>1,
			identity=>1,
			anonymous_identity=>1,
			mixed_cell=>1,
			password=>1,
			ca_cert=>1,
			client_cert=>1,
			private_key=>1,
			private_key_passwd=>1,
			dh_file=>1,
			subject_match=>1,
			phase1=>1,
			phase2=>1,
			ca_cert2=>1,
			client_cert2=>1,
			private_key2=>1,
			private_key2_passwd=>1,
			dh_file2=>1,
			subject_match2=>1,
			eappsk=>1,
			nai=>1,
			server_nai=>1,
			pac_file=>1,
			eap_workaround=>1,
			wep_tx_keyidx=>1,
			wep_key0=>1,
			wep_key1=>1,
			wep_key2=>1,
			wep_key4=>1,
		}
	};
	bless $self;

	#down syncs everything from the args hash to the object
	my $int=0;
	my @keys=keys(%args);
	while( defined( $keys[$int] ) ){
		if(! defined( $self->{valid}{$keys[$int]} ) ){
			$self->{perror}=1;
			$self->{error}=2;
			$self->{errorString}='"'.$keys[$int].'" is not a valid key';
		}

		$self->{$keys[$int]}=$args{$keys[$int]};

		$int++;
	}

	#make sure we have a SSID
	if( ! defined( $self->{ssid} ) ){
		$self->{error}=1;
		$self->{perror}=1;
		$self->{errorString}='No SSID specified';
		return $self;
	}
	
	return $self;
}

=head2 getKey

This returns the requested keys.

One value is required and that is the requested key.

Undef is a valid return value for this if the requested key is not defined.

Error checking is not required as long as the requested key is defined and
is valid.

    my $key=$foo->getKey( $key );
    if( $foo->error ){
        warn('error:'.$foo->error.': '.$foo->errorString);
    }

=cut