Giter Club home page Giter Club logo

indy-email-verification's Introduction

Lifecycle:Retired License

HL Indy Email Verification Service

⚠️ Retirement Notice ⚠️

This project has been retired and will no longer be maintained.

Pre-Requisites

jq and ngrok are available on package manager systems for different platforms such as Homebrew (Mac), Chocolatey (Windows) and various Linux distribution package managers.

Running

Open two shell/terminal sessions:

  1. From within the scripts folder execute ./start-ngrok.sh. This will create a tunnel for the agent.

  2. From within the docker folder:

    • run ./manage build to assemble the runtime images for the services
    • when the build completes, run ./manage up

Refer to manage -h for additional usage information.

Once services are started, visit http://localhost:8080 to see the app running and visit http://localhost:8050 to see any outbound mail the app is sending (it won't actually send any email message in the development environment.)

Deploying to Openshift

Param Files

You only need to edit the param file if you intend to deploy on your own namespace

Navigate to the openshift folder and view the existing param files. Go into email-verification-agent-deploy.param and email-verification-service-deploy.param and set NAMESPACE_NAME=a99fd4 and set it to whatever your project namespace is.

Also navigate to settings.sh and at the line export PROJECT_NAMESPACE=${PROJECT_NAMESPACE:-a99fd4} replace a99fd4 with your project namespace name

Builds

Now that our param files are set up, we're ready to start the builds using the openshift developer script here. Now that the builds have been completed it's time to start the deployment and tag the images

Deploy

Follow the deployment section to kickoff the deployment. Follow the prompts on the screen and the deployment will start. Look over the deployment configuration and make sure everything is in order, next tag the image streams

oc -n a99fd4-tools tag email-verification-agent:latest email-verification-agent:dev oc -n a99fd4-tools tag email-verification-service:latest email-verification-service:dev oc -n a99fd4-tools tag postgresql:latest postgresql:dev oc -n a99fd4-tools tag email-verification-demo:latest email-verification-demo:dev

This deployment will initially fail because we haven't registered our did and ver key on the ledger. To do so, go to https://email-verification-agent-admin-dev.apps.silver.devops.gov.bc.ca/api/doc or wherever you set your admin route to point to, and authorize with your api-key. Next scroll down untill to see the wallet section and execute the /wallet/did get request with no parameters. This should return your did and verkey.

Next we have to register our agent on the ledger. This tutorial uses the sovrin staging network but you can use whatever network you like, so long as it is exposed to the internet. if you're using sovrin staging, make sure you select StagingNet from the dropdown on the sovrin website. Enter your DID and VerKey in the fields and click submit (leave payment address blank).

Next we have to accept the taa. Go back to the swagger api interface and run get /ledger/taa from the ledger section. Copy the entire contents of the text attribute from the response and paste it into the text attribute in POST /ledger/taa/accept. Copy the version number as well and set the mechanism attribute to be at_submission. Execute the request and you should see an empty response body with status code 200.

Go back to the openshift developer console and start a rollout on email-verification-service if it hasn't already restarted. Once email-verification-service is up and running, you're ready to start issuing email credentials.

indy-email-verification's People

Contributors

andrewwhitehead avatar dependabot[bot] avatar esune avatar jljordan42 avatar nrempel avatar repo-mountie[bot] avatar swcurran avatar wadebarnes avatar wadeking98 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

indy-email-verification's Issues

Deploy test, prod services in OCP4

email-verification services should be deployed in test, prod.

  • test services are all-new and will need to be configured from scratch.
  • prod services should have their wallets carried over from the devex-von-image-tools namespace so we can decommission the old ones. @wadeking98 please proceed with deploying the agent in read only mode, using the wallet and secret values from OCP3. Once ready, coordinate with @WadeBarnes to add the vonx.io routes and certificates, and switch the DNS entry to point to the new cluster.

ngrok now requires a free account and authtoken

PM from ngrok here. I'm opening this issue to let you know what ngrok has recently started requiring a free account and authtoken to start the agent. It looks like your software might already work with an authtoken, but there might be users or integrations or docs that need to updated.

Please reach out to [email protected] if you are having any issues.

Thanks again for using ngrok!

I've copied the original notice posted to twitter below:

As a part of our ongoing efforts to make ngrok more secure, starting on December 19, 2023, all usage of ngrok will require an account on either our free or paid tiers. 

To connect to the ngrok service via the agent, SDK, or ingress controller, you must add a valid authtoken that is linked to an active free or paid account. Any new or existing connections without a valid authtoken will result in error code 4018.

Learn more here: https://ngrok.com/docs/errors/err_ngrok_4018/

Demo app for Verified Email

Deploy a new demo app to test vc-authn authentication using a Verified Email credential, now that the CSB Audio demo uses a different credential.

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

  • If this product is being actively maintained, please close this issue.
  • If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Issue Running Agent/App

Running in an Ubuntu VM (18.04/20.04 -->tried both)

Following basic steps in this demo app:

  1. script to start ngrok for agent tunnel
  2. manager build and then manage up

Getting the following error for the agent container:

Screenshot 2023-03-29 at 12 47 59 PM

When running with aca-py agent: ghcr.io/hyperledger/aries-cloudagent-python:py3.6-indy-1.16.0-0.8.0

the agent has no problem, and I can pull up the swagger api http://0.0.0.0:5000/api/doc#/

With both agents, the django app sending requests to that api does not run, see logs :
(container docker_email-verifier-service_1 is outputting the same for localhost:8080)

1

2

3

aiohttp.server ERROR Error handling request

Getting the below error while creating genesis transaction for email-verifier-agent:

File "/home/indy/src/aries-cloudagent/aries_cloudagent/ledger/indy.py", line 220, in _submit
email-verifier-agent_1 | f"Ledger rejected transaction request: {request_result['reason']}"
email-verifier-agent_1 | aries_cloudagent.ledger.error.LedgerTransactionError: Ledger rejected transaction request: client request invalid: UnauthorizedClientRequest('The action is forbidden',)

error submitting email

At email verification service page, submitting the email is failing with the below error :

Request Method: POST
http://...:8080/submit/
2.2.4
ProgrammingError
relation "email_verification_verification" does not exist LINE 1: INSERT INTO "email_verification_verification" ("email", "con... ^
/opt/app-root/lib/python3.6/site-packages/django/db/backends/utils.py in _execute, line 84
/opt/app-root/bin/python3
3.6.3
['/opt/app-root/src/email_verification_service', '/opt/app-root/bin', '/opt/app-root/src', '/opt/rh/rh-nodejs10/root/usr/lib/python2.7/site-packages', '/opt/app-root/lib64/python36.zip', '/opt/app-root/lib64/python3.6', '/opt/app-root/lib64/python3.6/lib-dynload', '/opt/rh/rh-python36/root/usr/lib64/python3.6', '/opt/rh/rh-python36/root/usr/lib/python3.6', '/opt/app-root/lib/python3.6/site-packages']
Thu, 31 Oct 2019 07:04:28 +0000

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means its critical that we work to make our content as discoverable as possible; Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

add a topic

That's in, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

  • If your org is not in the list below, or the table contains errors, please create an issue here.

  • While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

  • Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

  • If your application is live, add the production URL.

Ministry Short Codes

Short Code Organization Name
AEST Advanced Education, Skills & Training
AGRI Agriculture
ALC Agriculture Land Commission
AG Attorney General
MCF Children & Family Development
CITZ Citizens' Services
DBC Destination BC
EMBC Emergency Management BC
EAO Environmental Assessment Office
EDUC Education
EMPR Energy, Mines & Petroleum Resources
ENV Environment & Climate Change Strategy
FIN Finance
FLNR Forests, Lands, Natural Resource Operations & Rural Development
HLTH Health
FLNR Indigenous Relations & Reconciliation
JEDC Jobs, Economic Development & Competitiveness
LBR Labour Policy & Legislation
LDB BC Liquor Distribution Branch
MMHA Mental Health & Addictions
MAH Municipal Affairs & Housing
BCPC Pension Corporation
PSA Public Safety & Solicitor General & Emergency B.C.
SDPR Social Development & Poverty Reduction
TCA Tourism, Arts & Culture
TRAN Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 180 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

  • If this product is being actively maintained, please close this issue.
  • If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 187 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

  • If this product is being actively maintained, please close this issue.
  • If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.