Bläddra i källkod

Python usage and background info

Sean 4 år sedan
förälder
incheckning
37c88f8ef9
1 ändrade filer med 17 tillägg och 0 borttagningar
  1. 17 0
      readme.md

+ 17 - 0
readme.md

@@ -3,6 +3,9 @@
 This package allows you to authenticate with your MFA enabled Microsoft-Account into the
 openconnect VPN client.
 
+It uses selenium to open the login webpage and fill in the form details. At the end, it
+fetches the correct VPN HOST and the Cisco AnyConnect `webvpn` cookie.
+
 ## Example CLI usage
 
 Replace `[username]` and `[password]` with your own information. If you have your account
@@ -15,3 +18,17 @@ The secret in this case would be `NBSWY3DPEB3W64TMMQ`. This needs to be provided
 eval $( python ocma/cli.py -u [username] -p [password] -m [mfa_secret] --print-to-stdout );
 [ -n $VPN_COOKIE ] && echo $VPN_COOKIE | sudo openconnect --cookie-on-stdin $VPN_HOST
 ```
+
+## Example usage Python
+
+Add with poetry: `poetry add git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth`
+
+```python
+from ocma import connect
+
+connect.login(
+    username="username",
+    password="password",
+    mfa_secret="mfa_secret"
+)
+```