# IIT Madras Network Auth 

Cross platform desktop application for authentication devices with IIT Madras campus network.

![image](preview.png)


# IIT Madras Network Auth 

Cross platform desktop application for authenticating Windows/Linux/Mac devices with IIT Madras campus network. Built with [electron](http://electron.atom.io).

#### Note: app works only inside IIT Madras campus network.

![image](preview.png)

## Installation

Download the latest release for your platform from [GitHub Releases page](https://github.com/shahidhk/iitm-network-auth-app/releases).

## Usage

- Type in the username, password and click login.
- Check save option to keep username and password in the system.
- This will create a new session with IIT Madras network firewall.
- The connectivity indicator below the IITM logo shows current status, whether connected or not.
- Keep the application open to maintain the login session.
- Use the logout button to terminate the session.
- Note: each login session is valid for 10 minutes. The application refresh the session every 9 minutes. Hence, even if you close the application, the session maybe valid for at-most 10 minutes, unless you logout.
- The app will automatically download and install updates.

## Privacy and Security

- This application does not collect any personal information regarding the user. 
- The username and password used for authentication are stored using the `window.localStorage` method, in order to automatically connect at startup.
- The application may collect anonymous telemetry data for statistical purposes.
- The application will occasionally contact the update server for checking and downloading updates.

## Contributing

Pull requests and issues are most welcome.

The app is made using [electron](http://electron.atom.io), and built with [electron-builder](https://github.com/electron-userland/electron-builder) using [Travis CI](https://travis-ci.org) for Linux/Mac builds and [Appveyor CI](http://www.appveyor.com) for Windows builds. 

## Todo
- Re-authentication on waking up from sleep.
- Implement `netaccess` authentication 

## Credits
- [electron](http://electron.atom.io)
- [electron-builder](https://github.com/electron-userland/electron-builder)
- [ea-todo](https://github.com/Vj3k0/ea-todo) by [Vjekoslav Ratkajec](https://github.com/Vj3k0)
- [Travis CI](https://travis-ci.org) 
- [Appveyor CI](http://www.appveyor.com)
- [iitm-network-auth](https://shahidhk.github.io/iitm-network-auth)

## License 

[MIT](LICENSE)

Update readme to include documentation
Update readme to include documentation
