Opis
Użyj interfejsu API chrome.vpnProvider, aby wdrożyć klienta sieci VPN.
Uprawnienia
vpnProviderDostępność
Pojęcia i użycie
Typowe zastosowanie browser.vpnProvider:
Utwórz konfiguracje sieci VPN, wywołując
createConfig(). Konfiguracja sieci VPN to stały wpis wyświetlany użytkownikowi w interfejsie ChromeOS. Użytkownik może wybrać konfigurację sieci VPN z listy i połączyć się z nią lub rozłączyć.Dodaj detektory do zdarzeń
onPlatformMessage,onPacketReceivedionConfigRemoved.Gdy użytkownik połączy się z konfiguracją VPN,
onPlatformMessageotrzyma wiadomość"connected". Okres między komunikatami"connected"i"disconnected"jest nazywany „sesją VPN”. W tym okresie rozszerzenie, które otrzymało wiadomość, jest uznawane za właściciela sesji VPN.Zainicjuj połączenie z serwerem VPN i uruchom klienta VPN.
Ustaw parametry połączenia, wywołując funkcję
setParameters().Powiadom o stanie połączenia
"connected", wywołującnotifyConnectionStateChanged().Jeśli poprzednie kroki zostaną wykonane bez błędów, zostanie utworzony tunel wirtualny do stosu sieciowego ChromeOS. Pakiety IP można wysyłać przez tunel, wywołując
sendPacket(), a wszystkie pakiety pochodzące z urządzenia z ChromeOS będą odbierane za pomocą modułu obsługi zdarzeńonPacketReceived.Gdy użytkownik rozłączy się z konfiguracją sieci VPN, zostanie wywołane zdarzenie
onPlatformMessagez komunikatem"disconnected".Jeśli konfiguracja VPN nie jest już potrzebna, można ją usunąć, wywołując metodę
destroyConfig().
Typy
Parameters
Właściwości
-
adres
tekst
Adres IP interfejsu VPN w notacji CIDR. Obecnie obsługiwany jest tylko standard IPv4.
-
broadcastAddress
ciąg znaków opcjonalny
Adres rozgłoszeniowy interfejsu VPN. (domyślnie: wywnioskowany z adresu IP i maski)
-
dnsServers
string[]
Lista adresów IP serwerów DNS.
-
domainSearch
string[] opcjonalne
Lista domen wyszukiwania. (domyślnie: brak domeny wyszukiwania)
-
exclusionList
string[]
Wyklucz z tunelu ruch w sieci do listy bloków IP w notacji CIDR. Można go używać do omijania ruchu do i z serwera VPN. Jeśli do miejsca docelowego pasuje wiele reguł, stosowana jest reguła z najdłuższym pasującym prefiksem. Wpisy odpowiadające temu samemu blokowi CIDR są traktowane jako duplikaty. Takie duplikaty na połączonej liście (exclusionList + inclusionList) są eliminowane, a dokładny zduplikowany wpis, który zostanie wyeliminowany, jest niezdefiniowany.
-
inclusionList
string[]
Uwzględnij ruch w sieci do listy bloków adresów IP w notacji CIDR do tunelu. Tego parametru można użyć do skonfigurowania tunelu dzielonego. Domyślnie do tunelu nie jest kierowany żaden ruch. Dodanie do tej listy wpisu „0.0.0.0/0” spowoduje przekierowanie całego ruchu użytkowników do tunelu. Jeśli do miejsca docelowego pasuje wiele reguł, stosowana jest reguła z najdłuższym pasującym prefiksem. Wpisy odpowiadające temu samemu blokowi CIDR są traktowane jako duplikaty. Takie duplikaty na połączonej liście (exclusionList + inclusionList) są eliminowane, a dokładny zduplikowany wpis, który zostanie wyeliminowany, jest niezdefiniowany.
-
mtu
ciąg znaków opcjonalny
Ustawienie MTU dla interfejsu VPN. (domyślnie: 1500 bajtów)
-
ponowne połączenie
ciąg znaków opcjonalny
Chrome 51 lub nowsza browser.* od Chrome 148Określa, czy rozszerzenie VPN implementuje automatyczne ponowne łączenie.
Jeśli ma wartość prawda, do sygnalizowania odpowiednich zdarzeń będą używane komunikaty platformy
linkDown,linkUp,linkChanged,suspendiresume. Jeśli zasada ma wartość Fałsz, system wymusi rozłączenie sieci VPN, gdy zmieni się topologia sieci, a użytkownik będzie musiał ponownie połączyć się ręcznie. (domyślnie: false)Ta właściwość jest nowa w Chrome 51. We wcześniejszych wersjach wygeneruje wyjątek. Możesz użyć try/catch, aby warunkowo włączyć tę funkcję w zależności od obsługi przeglądarki.
PlatformMessage
Typ wyliczeniowy jest używany przez platformę do powiadamiania klienta o stanie sesji VPN.
Typ wyliczeniowy
"connected"
Wskazuje, że konfiguracja sieci VPN została połączona.
"disconnected"
Wskazuje, że konfiguracja sieci VPN została rozłączona.
"error"
Wskazuje, że wystąpił błąd połączenia VPN, na przykład przekroczenie limitu czasu. Opis błędu jest podany jako argument błędu w onPlatformMessage.
"linkDown"
Wskazuje, że domyślne fizyczne połączenie sieciowe jest wyłączone.
"linkUp"
Wskazuje, że domyślne połączenie sieciowe zostało przywrócone.
"linkChanged"
Wskazuje, że domyślne fizyczne połączenie sieciowe uległo zmianie, np. Wi-Fi -> sieć komórkowa.
"suspend"
Wskazuje, że system operacyjny przygotowuje się do zawieszenia, więc sieć VPN powinna przerwać połączenie. Nie ma gwarancji, że rozszerzenie otrzyma to zdarzenie przed zawieszeniem.
"resume"
Wskazuje, że system operacyjny został wznowiony, a użytkownik zalogował się ponownie, więc sieć VPN powinna spróbować ponownie nawiązać połączenie.
UIEvent
Platforma używa typu wyliczeniowego, aby wskazać zdarzenie, które wywołało onUIEvent.
Typ wyliczeniowy
"showAddDialog"
Żąda, aby klient VPN wyświetlił użytkownikowi okno dodawania konfiguracji.
"showConfigureDialog"
Żąda, aby klient VPN wyświetlił użytkownikowi okno ustawień konfiguracji.
VpnConnectionState
Typ wyliczeniowy jest używany przez klienta VPN do informowania platformy o jego bieżącym stanie. Dzięki temu użytkownik otrzymuje przydatne komunikaty.
Typ wyliczeniowy
"connected"
Określa, że połączenie VPN zostało nawiązane.
"failure"
Określa, że połączenie VPN nie powiodło się.
Metody
createConfig()
browser.vpnProvider.createConfig(
name: string,
): Promise<string>
Tworzy nową konfigurację sieci VPN, która jest zachowywana w wielu sesjach logowania użytkownika.
Parametry
-
nazwa
tekst
Nazwa konfiguracji sieci VPN.
Zwroty
-
Promise<string>
Chrome 96 lub nowsza wersja browser.* od Chrome 148Zwraca obiekt Promise, który jest rozwiązywany po utworzeniu konfiguracji lub odrzucany w przypadku błędu.
destroyConfig()
browser.vpnProvider.destroyConfig(
id: string,
): Promise<void>
Usuwa konfigurację sieci VPN utworzoną przez rozszerzenie.
Parametry
-
id
tekst
Identyfikator konfiguracji sieci VPN do usunięcia.
Zwroty
-
thought Promise<void>
Chrome 96 lub nowsza wersja browser.* od Chrome 148Zwraca obiekt Promise, który jest rozwiązywany, gdy konfiguracja zostanie zniszczona, lub odrzucany, jeśli wystąpi błąd.
notifyConnectionStateChanged()
browser.vpnProvider.notifyConnectionStateChanged(
state: VpnConnectionState,
): Promise<void>
Powiadamia platformę o stanie sesji VPN. Zakończy się to powodzeniem tylko wtedy, gdy sesja VPN należy do rozszerzenia.
Parametry
-
stan
Stan sesji VPN klienta VPN.
Zwroty
-
thought Promise<void>
Chrome 96 lub nowsza wersja browser.* od Chrome 148Zwraca obiekt Promise, który jest spełniany po zakończeniu powiadomienia lub odrzucany, jeśli wystąpi błąd.
sendPacket()
browser.vpnProvider.sendPacket(
data: ArrayBuffer,
): Promise<void>
Wysyła pakiet IP przez tunel utworzony na potrzeby sesji VPN. Zakończy się to powodzeniem tylko wtedy, gdy sesja VPN należy do rozszerzenia.
Parametry
-
dane
ArrayBuffer
Pakiet IP, który ma zostać wysłany na platformę.
Zwroty
-
thought Promise<void>
Chrome 96 lub nowsza wersja browser.* od Chrome 148Zwraca obiekt Promise, który jest rozwiązywany po wysłaniu pakietu lub odrzucany w przypadku błędu.
setParameters()
browser.vpnProvider.setParameters(
parameters: Parameters,
): Promise<void>
Ustawia parametry sesji VPN. Należy ją wywołać natychmiast po otrzymaniu "connected" z platformy. Zakończy się to powodzeniem tylko wtedy, gdy sesja VPN należy do rozszerzenia.
Parametry
-
parametry
Parametry sesji VPN.
Zwroty
-
thought Promise<void>
Chrome 96 lub nowsza wersja browser.* od Chrome 148Zwraca obiekt Promise, który jest rozwiązywany po ustawieniu parametrów lub odrzucany w przypadku błędu.
Wydarzenia
onConfigCreated
browser.vpnProvider.onConfigCreated.addListener(
callback: function,
)
Uruchamiane, gdy platforma tworzy konfigurację rozszerzenia.
Parametry
-
callback
funkcja
Parametr
callbackwygląda tak:(id: string, name: string, data: object) => void
-
id
tekst
-
nazwa
tekst
-
dane
obiekt
-
onConfigRemoved
browser.vpnProvider.onConfigRemoved.addListener(
callback: function,
)
Uruchamiane, gdy konfiguracja utworzona przez rozszerzenie zostanie usunięta przez platformę.
Parametry
-
callback
funkcja
Parametr
callbackwygląda tak:(id: string) => void
-
id
tekst
-
onPacketReceived
browser.vpnProvider.onPacketReceived.addListener(
callback: function,
)
Uruchamiane, gdy pakiet IP zostanie odebrany przez tunel sesji VPN należącej do rozszerzenia.
Parametry
-
callback
funkcja
Parametr
callbackwygląda tak:(data: ArrayBuffer) => void
-
dane
ArrayBuffer
-
onPlatformMessage
browser.vpnProvider.onPlatformMessage.addListener(
callback: function,
)
Uruchamiane, gdy z platformy zostanie odebrana wiadomość dotycząca konfiguracji sieci VPN należącej do rozszerzenia.
Parametry
-
callback
funkcja
Parametr
callbackwygląda tak:(id: string, message: PlatformMessage, error: string) => void
-
id
tekst
-
wiadomość
-
błąd
tekst
-
onUIEvent
browser.vpnProvider.onUIEvent.addListener(
callback: function,
)
Uruchamiane, gdy wystąpi zdarzenie interfejsu rozszerzenia. Zdarzenia interfejsu to sygnały z platformy, które wskazują aplikacji, że użytkownikowi należy wyświetlić okno interfejsu.