GenerateDidWeb

DID:web Generator for GitHub Pages

This repository provides a simple yet powerful tool to generate and manage DID documents using the did:web method. It creates a new elliptic curve key pair and a corresponding DID document that you can host on GitHub Pages. It is based on this project

Once published, your DID will have the form:

did:web:USERNAME.github.io (for user site repos)
did:web:USERNAME.github.io:PROJECT (for other repositories)
did:web:USERNAME.github.io:PROJECT:FOLDER (for subfolders within project)

🛠️ Quick Start

1. Clone Your GitHub Repository

git clone https://github.com/YOUR_USERNAME/YOUR_REPO
cd YOUR_REPO

2. Set Up Environment (Poetry)

Ensure Poetry is installed:

curl -sSL https://install.python-poetry.org | python3 -

Then install dependencies:

poetry install

Activate the virtual environment:

poetry shell

3. Run the Generator

Option A: Use default DID based on repo

python generate.py

Option B: Generate for a specific folder

python generate.py my-did-folder

Option C: Specify full DID explicitly

python generate.py did:web:example.com:device-1

4. Push to GitHub

git push

🔄 GitHub Pages Note

Change the setting of the repository to “Use GitHub Pages website”

`.nojekyll` File

GitHub Pages uses Jekyll by default, which ignores files and folders that start with a dot (.) — including .well-known, which is essential for some did:web resolutions.

To ensure your DID documents are publicly accessible (especially if you’re using nested or dot-prefixed folders), you must disable Jekyll by adding a .nojekyll file to the root of your repository.

📁 Output Structure

If no folder is specified:

├── did.json            # DID Document (public)
├── private_key.pem     # EC private key (keep secret!)
├── generate.py         # Generator script

If folder is specified:

├── my-did-folder/
│   ├── did.json
│   └── private_key.pem
└── generate.py

🔐 Security Notes

⚠️ Never publish private_key.pem.
Ensure .gitignore includes *.pem.
Store your key securely — it’s needed to prove control over the DID.

✅ DID Resolution & Verification

After pushing to GitHub:

Wait ~2–5 minutes for GitHub Pages deployment
Verify your DID at:
- 🔗 Universal Resolver
- 🧪 Direct fetch:
```
curl https://USERNAME.github.io/device-1/did.json
```

🧠 How It Works

Generates a SECP384R1 key pair
Converts public key to JWK
Constructs a compliant DID document using JsonWebKey2020
Commits the did.json file to the repo

🧪 Troubleshooting

❌ DID not resolving?

Wait 5–10 minutes for GitHub Pages
Ensure GitHub Pages is enabled
Verify public access to did.json

❌ “Could not infer DID from git”

Ensure you are in a Git repo
Run git remote -v and confirm GitHub origin

❌ Wrong DID returned?

Make sure the id in did.json exactly matches the requested DID (path, case-sensitive)

🔍 Standards Compliance

This generator adheres to:

🤝 Contributing

Contributions are welcome! To propose improvements:

Fork this repo
Create a feature branch
Submit a pull request

🔗 Resources

This site is open source. Improve this page.