Forgot Password in OSM

Proposers

• Jegan S (Tata Elxsi)
• Deepika E (Tata Elxsi)
• Jayaprakash G (Tata Elxsi)
• Ramesh Ramanathan (Tata Elxsi)

Description

Currently, users created in OSM cannot reset their password if they have forgotten it. This feature is to allow users to reset their password using registered Email Id.

Demo or definition of done

Users should be able to reset their password using Email Id. A Robot test will be created or updated to test this functionality.

changed the description

changed the description

added PRESENTED IN TECH CALL label

removed PRESENTED IN TECH CALL label

changed milestone to %Approved

changed milestone to %Design

Where is the SMTP client going to run? Is it expected to be part of the ng-ui server? Will there be logs via the UI or does the admin need to look at the k8s logs to determine why email is not working.

Also there will need to be screens for configuring the SMTP server, user to use, password management for mailserver if needed, etc.

@beierlm There won't be any SMTP client running in NGUI, using smtplib library in python email will be sent from NBI and for this it requires an existing SMTP server. SMTP server credentials, sender email Id to use, the sender email Id's password and smtp server configurations will be configured as env variables and Kubernetes secrets in NBI and will be used for sending the email with OTP.

assigned to @sjega

added to epic &17

Checklist for feature owners:

• Add the link to the design (Etherpad)
• Add the links to the Gerrit changes (commits), in a single message, related to the feature and update the list when needed.
• Contribute documentation in osm-user-guide and add link to the merge request.
• Contribute release notes for the feature and add link to the merge request.
• Relate IM changes to SOL006 v2.6.1
• Relate NBI changes to SOL005 v3.3.1
• Add E2E Robot Test. If no Robot Test is required, it should be explicitly explained.

added NBI label

added NGUI osmclient labels

changed milestone to %Development

• Design: https://osm.etsi.org/pad/p/feature11034
• Gerrit changes:
  • WIP
• Relate IM changes to SOL006 v2.6.1: N/A
• Relate NBI changes to SOL005 v3.3.1: PENDING
• Documentation: PENDING
• Release Notes: PENDING
• E2E Robot Test. A new test is required. PENDING

changed milestone to %Testing and Review

changed milestone to %Development

• Design: https://osm.etsi.org/pad/p/feature11034
• Gerrit changes:
  • NBI: https://osm.etsi.org/gerrit/#/c/osm/NBI/+/14412/
  • NG-UI: https://osm.etsi.org/gerrit/#/c/osm/NG-UI/+/14418/
  • osmclient: https://osm.etsi.org/gerrit/#/c/osm/osmclient/+/14413/
  • devops: https://osm.etsi.org/gerrit/#/c/osm/devops/+/14466/
• Relate IM changes to SOL006 v2.6.1: N/A
• Relate NBI changes to SOL005 v3.3.1: PENDING
• Documentation: PENDING
• Release Notes: PENDING
• E2E Robot Test. A new test is required. PENDING

@garciadeblas for this feature, SMTP relay is a pre-requisite and robot tests for this feature would require a SMTP server and OTP will be read from email. So, for implementing End-to-End Robot Test SMTP relay is required.

First I suggest that you think how to pass the env vars to the NBI, which is not possible right now.

OSMNBI_SMTP_SERVER
OSMNBI_SMTP_PORT
OSMNBI_SENDER_EMAIL
OSMNBI_EMAIL_PASSWORD
OSMNBI_OTP_RETRY_COUNT
OSMNBI_OTP_EXPIRY_TIME

These env vars should be able to reach NBI during OSM installation and also after, for instance, doing an update of the OSM helm chart.

For the test, I suggest that you first devise the whole method for the test. For testing, you can use any e-mail address and SMTP server as long as it works. For instance, a free e-mail account would do.

Later on, when the tests have proved to work, we could request one email account to ETSI for the tests.

changed milestone to %Testing and Review