Skip to content

Commit

Permalink
refactor access and accounting (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcumming authored Feb 13, 2025
1 parent 3e0d9aa commit 9ce668f
Show file tree
Hide file tree
Showing 12 changed files with 352 additions and 288 deletions.
21 changes: 5 additions & 16 deletions docs/access/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
# Access and Accounting
# Connecting to Alps

Users at CSCS typically have one account that can be used to access all services at CSCS.
This documentation guides users through the process of accessing CSCS systems and services.

<div class="grid cards" markdown>
!!! info
Before accessing CSCS, you need to have an account at CSCS, and be part of a project that has been allocated resources.
More information on how to get an account is available in [accounts and projects][account-management].

- :fontawesome-solid-mountain-sun: __Multi Factor Authetification (MFA)__

A guide to setting up and using MFA.

[:octicons-arrow-right-24: Setting up and use MFA][mfa]

- :fontawesome-solid-mountain-sun: __Getting Access__

A project is required to get access to resources on Alps.
Instructions on how to submit a project proposal is available on the main CSCS web site.

[:octicons-arrow-right-24: Applying for an Alps project](https://www.cscs.ch/user-lab/applying-for-accounts)
</div>

There are different ways to authenticate your identity in order to access services at CSCS, using a password set by the user. Currently users can be authenticated with:

Expand Down
86 changes: 86 additions & 0 deletions docs/access/mfa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
[](){#mfa}
# Multi Factor Authentification

To access CSCS services and systems users are required to authenticate using multi-factor authentication (MFA).
MFA is implemented as a two-factor authentication, where one factor is the login and password pair ("the thing you know") and the other factor is the device which generates one-time passwords (OTPs, "the thing you have").
In this way security is significantly improved compared to single-factor (password only) authentication.

The MFA workflow uses a time-based one-time password (OTP) to verify identity.
An OTP is a six-digit number which changes every 30 seconds.
OTPs are generated using a tool installed on a device other than the one used to access CSCS services and infrastructure.
We recommend to use a smartphone with an application such as Google Authenticator to obtain the OTPs.

[](){#mfa-setup}
## Getting Started

When you first log in to any of the CSCS web applications such as UMP, Jupyter, etc., you will be asked to register your device.

Firstly, you will be asked to provide a code that you received by email.
After this validation step, you will need to scan a QR code with your mobile phone using an application such as Google Authenticator.
Lastly, you will need to enter the OTP from the authenticator application to complete the registration of your device.
From then on, two-factor authrentication will be required to access CSCS services and systems.
A more detailed explanation of the registration process is provided in the next section.

!!! warning
It is not possible to log in to CSCS systems using SSH without registering a device and creating certified SSH keys.
See below for details on generating certified SSH keys.

### Authenticator Application

CSCS supports authenticators that follow an open standard called [TOTP](https://en.wikipedia.org/wiki/Time-based_one-time_password).
The recommended way to access such an authenticator is to install an application on your mobile phone.
Google Authenticator and FreeOTP have been tested successfully; however, if you are using a different mobile application for OTPs, feel free to continue using it - given it supports the TOTP standard.

You can download Google Authenticator for your phone:

* :fontawesome-brands-android: Android: on the [Google Play Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).
* :fontawesome-brands-apple: iOS: on the [Apple Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).

[](){#mfa-configure-otp}
### Configure the Authenticator

Before starting, ensure that the following pre-requisites are satisfied

1. You have an invitation email from CSCS for MFA enrollment
* a notification email will be sent atleast one week before we sent the invitation email.
2. You have installed an OTP Authenticator app on your mobile device (see above).

!!! note
If you try access any of our web applications without setting up MFA, you will be redirected to enroll for MFA.

!!! warning
If you try to SSH to CSCS systems without setting up MFA, you will be prompted with permission denied error, for example:
```
> ssh ela.cscs.ch
[email protected]: Permission denied (publickey).
Connection closed by UNKNOWN port 65535
```

Steps:

1. Access any of the CSCS Web applications such as [`account.cscs.ch`](https://account.cscs.ch), Jupyter, etc., on a new browser session which will redirects you to the CSCS login page.
2. Log in with your username and password.
3. You will be asked to key in a code which CSCS Authentication system sent to you by email.
After successfaul validation of the code you will be redirected to the next page which present a QR code.
4. Scan the QR code with the authenticator app that was installed on your mobile device.
After scanning the QR code the authenticator app will start generating a new 6 digit OTP every 60 seconds.
5. To complete the OTP registration process, please enter the 6 digit OTP from the authenticator app at the bottom of the the same QR code page. Optionally, you can input your device name where you imported the OTP seed by scanning the QR code
6. On successful registration you will be logged into the CSCS web application that you accessed in step-1

!!! todo
do we need the images from KB?

### Resetting the Authenticator

In case users lose access to their mobile device/Authenticator OTP, users can reset their OTP by following the below self-service process.

1. Access any CSCS web application like: [account.cscs.ch](https://account.cscs.ch/) which redirects you to the CSCS Login page.
2. From the login screen, click the "Reset OTP" link below the "LOG IN" button
3. Enter your username and password.
4. On successful validation of user credentials, users will receive an email with a reset credentials link like the one below, click on the link in the email
5. The steps are the same as for the first time you [configured the authenticator][mfa-configure-otp].

!!! warning
When replacing your smartphone remember to sync the authenticator app before resetting the old smartphone.
Otherwise, you will have to follow this process.

250 changes: 0 additions & 250 deletions docs/access/mfa/index.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/access/mfa/windows.md

This file was deleted.

Loading

0 comments on commit 9ce668f

Please sign in to comment.