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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
package client
import (
"github.com/eduvpn/eduvpn-common/internal/fsm"
)
type (
FSMStateID = fsm.StateID
FSMStates = fsm.States
FSMState = fsm.State
FSMTransition = fsm.Transition
)
const (
// StateDeregistered means the app is not registered with the wrapper.
StateDeregistered FSMStateID = iota
// StateNoServer means the user has not chosen a server yet.
StateNoServer
// StateAskLocation means the user selected a Secure Internet server but needs to choose a location.
StateAskLocation
// StateChosenLocation means the user has selected a Secure Internet location
StateChosenLocation
// StateLoadingServer means we are loading the server details.
StateLoadingServer
// StateChosenServer means the user has chosen a server to connect to and the server is initialized.
StateChosenServer
// StateOAuthStarted means the OAuth process has started.
StateOAuthStarted
// StateAuthorized means the OAuth process has finished and the user is now authorized with the server.
StateAuthorized
// StateRequestConfig means the user has requested a config for connecting.
StateRequestConfig
// StateAskProfile means the go code is asking for a profile selection from the UI.
StateAskProfile
// StateChosenProfile means a profile has been chosen
StateChosenProfile
// StateGotConfig means a VPN configuration has been obtained
StateGotConfig
// The following states are only here for clients that want to use them
// StateConnecting means the VPN is connecting
StateConnecting
// StateDisconnecting means the VPN is disconnecting
StateDisconnecting
// StateConnected means the VPN is connected
StateConnected
)
func GetStateName(s FSMStateID) string {
switch s {
case StateDeregistered:
return "Deregistered"
case StateNoServer:
return "No_Server"
case StateAskLocation:
return "Ask_Location"
case StateLoadingServer:
return "Loading_Server"
case StateChosenServer:
return "Chosen_Server"
case StateChosenLocation:
return "Chosen_Location"
case StateOAuthStarted:
return "OAuth_Started"
case StateRequestConfig:
return "Request_Config"
case StateAskProfile:
return "Ask_Profile"
case StateChosenProfile:
return "Chosen_Profile"
case StateAuthorized:
return "Authorized"
case StateGotConfig:
return "Got_Config"
case StateConnecting:
return "Connecting"
case StateDisconnecting:
return "Disconnecting"
case StateConnected:
return "Connected"
default:
panic("unknown conversion of state to string")
}
}
func newFSM(
callback func(FSMStateID, FSMStateID, interface{}) bool,
directory string,
debug bool,
) fsm.FSM {
states := FSMStates{
StateDeregistered: FSMState{
Transitions: []FSMTransition{{To: StateNoServer, Description: "Client registers"}},
},
StateNoServer: FSMState{
Transitions: []FSMTransition{
{To: StateAskLocation, Description: "The client wants to ask for a location on the main screen"},
{To: StateLoadingServer, Description: "User clicks a server in the UI"},
{To: StateConnected, Description: "The VPN is still active"},
},
},
StateAskLocation: FSMState{
Transitions: []FSMTransition{
{To: StateChosenLocation, Description: "Location chosen"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateChosenLocation: FSMState{
Transitions: []FSMTransition{
{To: StateChosenServer, Description: "Server has been chosen"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateLoadingServer: FSMState{
Transitions: []FSMTransition{
{To: StateChosenServer, Description: "Server info loaded"},
{
To: StateAskLocation,
Description: "User chooses a Secure Internet server but no location is configured",
},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateChosenServer: FSMState{
Transitions: []FSMTransition{
{To: StateAuthorized, Description: "Found tokens in config"},
{To: StateOAuthStarted, Description: "No tokens found in config"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateOAuthStarted: FSMState{
Transitions: []FSMTransition{
{To: StateAuthorized, Description: "User authorizes with browser"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateAuthorized: FSMState{
Transitions: []FSMTransition{
{To: StateOAuthStarted, Description: "Re-authorize with OAuth"},
{To: StateRequestConfig, Description: "Client requests a config"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateRequestConfig: FSMState{
Transitions: []FSMTransition{
{To: StateAskProfile, Description: "Multiple profiles found and no profile chosen"},
{To: StateChosenProfile, Description: "Only one profile or profile already chosen"},
{To: StateOAuthStarted, Description: "Re-authorize"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateAskProfile: FSMState{
Transitions: []FSMTransition{
{To: StateNoServer, Description: "Cancel or Error"},
{To: StateChosenProfile, Description: "Profile has been chosen"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateChosenProfile: FSMState{
Transitions: []FSMTransition{
{To: StateGotConfig, Description: "Config has been obtained"},
{To: StateNoServer, Description: "Go back or Error"},
{To: StateGotConfig, Description: "Go back or Error"},
},
},
StateGotConfig: FSMState{
Transitions: []FSMTransition{
{To: StateNoServer, Description: "Choose a new server"},
{To: StateLoadingServer, Description: "Get a new configuration"},
{To: StateConnecting, Description: "VPN is connecting"},
},
},
StateConnecting: FSMState{
Transitions: []FSMTransition{
{To: StateGotConfig, Description: "Go back or Error"},
{To: StateConnected, Description: "Done connecting"},
},
},
StateConnected: FSMState{
Transitions: []FSMTransition{
{To: StateDisconnecting, Description: "The VPN is disconnecting"},
},
},
StateDisconnecting: FSMState{
Transitions: []FSMTransition{
{To: StateGotConfig, Description: "Done disconnecting"},
{To: StateConnected, Description: "Go back or Error"},
},
},
}
returnedFSM := fsm.FSM{}
returnedFSM.Init(StateDeregistered, states, callback, directory, GetStateName, debug)
return returnedFSM
}
|
