Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 3.52 KB

README.md

File metadata and controls

116 lines (84 loc) · 3.52 KB
Raw

FSLogin

ADFS & Vulcan CUFS Login module

Usage

Install the library dependency.

repositories {
    jcenter()
    maven { url "https://jitpack.io" }
}
dependencies {
    implementation 'eu.szkolny.fslogin:lib:<version>'
}

You can check the version on the GitHub releases page, or use master-SNAPSHOT for the latest version (not recommended though, may be unstable).

Create a Realm.

You may obtain most of the supported login realms from the FSLogin Realms page. The selected realmData may be used to create an appropriate Realm.

val realmData = RealmData() // pass the values here
val realm = realmData.toRealm()

You can deserialize the realmData JSON directly to an object, using e.g. Retrofit or Gson.

Log in

In order to get a certificate, create an instance of FSLogin.

val http = OkHttpClient.Builder()
                // you need to have a working cookie jar
                .cookieJar(MyCookieJar())
                // to support most of the realms, as some are using insecure TLS
                .connectionSpecs(listOf(ConnectionSpec.COMPATIBLE_TLS))
                .build()
val fsLogin = FSLogin(http, debug = true)

Then just call fsLogin.performLogin(realm, username, password, onSuccess, onFailure):

fsLogin.performLogin(
    realm = CufsRealm(host = "fakelog.cf", symbol = "powiatwulkanowy"),
    username = "jan@fakelog.cf",
    password = "jan123",
    onSuccess = { certificate -> 

    },
    onFailure = { errorText ->

    }
)

Final step

A certificate retrieved in onSuccess may be POSTed to realm.getFinalRealm() to complete the login process:

// returns an HTML body of the website
val result = fsLogin.api.postCertificate(certificate.formAction, mapOf(
    "wa" to certificate.wa,
    "wresult" to certificate.wresult,
    "wctx" to certificate.wctx
)).execute().body()

You can use a custom method for posting those form fields.

Sample code

Check the sample module.

Special thanks to

Wulkanowy's SDK library for a general idea about how all this works and for testing the library by their great community.

SDK provided under Apache License 2.0.

License

MIT License

Copyright (c) 2021 kuba2k2

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Use whatever you want, but please include a copyright notice :)