1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License
15  */
16 
17 package android.net;
18 
19 import android.annotation.NonNull;
20 import android.annotation.Nullable;
21 import android.annotation.SystemApi;
22 import android.os.Parcel;
23 import android.os.Parcelable;
24 
25 import java.util.Objects;
26 import java.util.regex.Pattern;
27 
28 /**
29  * Information identifying a Wi-Fi network.
30  * @see NetworkKey
31  *
32  * @deprecated as part of the {@link NetworkScoreManager} deprecation.
33  * @hide
34  */
35 @Deprecated
36 @SystemApi
37 public class WifiKey implements Parcelable {
38 
39     // Patterns used for validation.
40     private static final Pattern SSID_PATTERN = Pattern.compile("(\".*\")|(0x[\\p{XDigit}]+)",
41             Pattern.DOTALL);
42     private static final Pattern BSSID_PATTERN =
43             Pattern.compile("([\\p{XDigit}]{2}:){5}[\\p{XDigit}]{2}");
44 
45     /**
46      * The service set identifier (SSID) of an 802.11 network. If the SSID can be decoded as
47      * UTF-8, it will be surrounded by double quotation marks. Otherwise, it will be a string of
48      * hex digits starting with 0x.
49      */
50     public final String ssid;
51 
52     /**
53      * The basic service set identifier (BSSID) of an access point for this network. This will
54      * be in the form of a six-byte MAC address: {@code XX:XX:XX:XX:XX:XX}, where each X is a
55      * hexadecimal digit.
56      */
57     public final String bssid;
58 
59     /**
60      * Construct a new {@link WifiKey} for the given Wi-Fi SSID/BSSID pair.
61      *
62      * @param ssid the service set identifier (SSID) of an 802.11 network. If the SSID can be
63      *         decoded as UTF-8, it should be surrounded by double quotation marks. Otherwise,
64      *         it should be a string of hex digits starting with 0x.
65      * @param bssid the basic service set identifier (BSSID) of this network's access point.
66      *         This should be in the form of a six-byte MAC address: {@code XX:XX:XX:XX:XX:XX},
67      *         where each X is a hexadecimal digit.
68      * @throws IllegalArgumentException if either the SSID or BSSID is invalid.
69      */
WifiKey(String ssid, String bssid)70     public WifiKey(String ssid, String bssid) {
71         if (ssid == null || !SSID_PATTERN.matcher(ssid).matches()) {
72             throw new IllegalArgumentException("Invalid ssid: " + ssid);
73         }
74         if (bssid == null || !BSSID_PATTERN.matcher(bssid).matches()) {
75             throw new IllegalArgumentException("Invalid bssid: " + bssid);
76         }
77         this.ssid = ssid;
78         this.bssid = bssid;
79     }
80 
WifiKey(Parcel in)81     private WifiKey(Parcel in) {
82         ssid = in.readString();
83         bssid = in.readString();
84     }
85 
86     @Override
describeContents()87     public int describeContents() {
88         return 0;
89     }
90 
91     @Override
writeToParcel(Parcel out, int flags)92     public void writeToParcel(Parcel out, int flags) {
93         out.writeString(ssid);
94         out.writeString(bssid);
95     }
96 
97     @Override
equals(@ullable Object o)98     public boolean equals(@Nullable Object o) {
99         if (this == o) return true;
100         if (o == null || getClass() != o.getClass()) return false;
101 
102         WifiKey wifiKey = (WifiKey) o;
103 
104         return Objects.equals(ssid, wifiKey.ssid) && Objects.equals(bssid, wifiKey.bssid);
105     }
106 
107     @Override
hashCode()108     public int hashCode() {
109         return Objects.hash(ssid, bssid);
110     }
111 
112     @NonNull
113     @Override
toString()114     public String toString() {
115         return "WifiKey[SSID=" + ssid + ",BSSID=" + bssid + "]";
116     }
117 
118     public static final @android.annotation.NonNull Creator<WifiKey> CREATOR =
119             new Creator<WifiKey>() {
120                 @Override
121                 public WifiKey createFromParcel(Parcel in) {
122                     return new WifiKey(in);
123                 }
124 
125                 @Override
126                 public WifiKey[] newArray(int size) {
127                     return new WifiKey[size];
128                 }
129             };
130 }
131