summaryrefslogtreecommitdiff
path: root/src/fsm.go
blob: fa2a5c455191fd0d684e13c06ddb8647fda8b9ba (plain)
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
package eduvpn

import (
	"fmt"
	"os"
)

type FSMStateID int8

const (
	// Deregistered means the app is not registered with the wrapper
	DEREGISTERED FSMStateID = iota

	// No Server means the user has not chosen a server yet
	NO_SERVER

	// Chosen Server means the user has chosen a server to connect to
	CHOSEN_SERVER

	// OAuth Started means the OAuth process has started
	OAUTH_STARTED

	// Authenticated means the OAuth process has finished and the user is now authenticated with the server
	AUTHENTICATED

	// Connected means the user has been connected to the server
	CONNECTED
)

func (s FSMStateID) String() string {
	switch s {
	case DEREGISTERED:
		return "Deregistered"
	case NO_SERVER:
		return "No_Server"
	case CHOSEN_SERVER:
		return "Chosen_Server"
	case OAUTH_STARTED:
		return "OAuth_Started"
	case AUTHENTICATED:
		return "Authenticated"
	case CONNECTED:
		return "Connected"
	default:
		panic("unknown conversion of state to string")
	}
}

type FSMTransition struct {
	To FSMStateID
	Description string
}

type (
	FSMTransitions []FSMTransition
	FSMStates      map[FSMStateID]FSMTransitions
)

type FSM struct {
	States  FSMStates
	Current FSMStateID
}

func (eduvpn *VPNState) HasTransition(check FSMStateID) bool {
	for _, transition_state := range eduvpn.FSM.States[eduvpn.FSM.Current] {
		if transition_state.To == check {
			return true
		}
	}

	return false
}

func (eduvpn *VPNState) InState(check FSMStateID) bool {
	return check == eduvpn.FSM.Current
}

func (eduvpn *VPNState) writeGraph() {
	graph := eduvpn.GenerateGraph()

	f, err := os.Create("debug.graph")
	if err != nil {
		eduvpn.Log(LOG_INFO, fmt.Sprintf("Failed to write debug fsm graph with error %v", err))
	}

	defer f.Close()

	f.WriteString(graph)
}

func (eduvpn *VPNState) GoTransition(newState FSMStateID, data string) bool {
	ok := eduvpn.HasTransition(newState)

	if ok {
		oldState := eduvpn.FSM.Current
		eduvpn.FSM.Current = newState
		if eduvpn.Debug {
			eduvpn.writeGraph()
		}
		eduvpn.StateCallback(oldState.String(), newState.String(), data)
	}

	return ok
}

func (eduvpn *VPNState) generateDotGraph() string {
	graph := `digraph eduvpn_fsm {
nodesep = 2;
remincross = false;
`
	graph += "node[color=blue]; " + eduvpn.FSM.Current.String() + ";\n"
	graph += "node [color=black];\n"
	for state, transitions := range eduvpn.FSM.States {
		for _, transition := range transitions {
			graph += state.String() + " -> " + transition.To.String() + " [label=\"" + transition.Description + "\"]\n"
		}
	}
	graph += "}"
	return graph
}

func (eduvpn *VPNState) generateMermaidGraph() string {
	graph := "graph TD\n"
	graph += "style " + eduvpn.FSM.Current.String() + " fill:cyan\n"
	for state, transitions := range eduvpn.FSM.States {
		for _, transition := range transitions {
			graph += state.String() + "(" + state.String() + ") " + "-->|" + transition.Description + "| " + transition.To.String() + "\n"
		}
	}
	return graph
}

func (eduvpn *VPNState) GenerateGraph() string {
	return eduvpn.generateMermaidGraph()
}

func (eduvpn *VPNState) InitializeFSM() {
	eduvpn.FSM = &FSM{
		States: FSMStates {
			DEREGISTERED: {{NO_SERVER, "Client registers"}},
			NO_SERVER: {{CHOSEN_SERVER, "User chooses a server"}},
			CHOSEN_SERVER: {{AUTHENTICATED, "Found tokens in config"}, {OAUTH_STARTED, "No tokens found in config"}},
			OAUTH_STARTED: {{AUTHENTICATED, "User authorizes with browser"}},
			AUTHENTICATED: {{CONNECTED, "OS reports connected"}},
			CONNECTED: {{AUTHENTICATED, "OS reports disconnected"}},
		},
		Current: DEREGISTERED,
	}
}