conan-auth-source-plugin 0.0.5__tar.gz

conan_auth_source_plugin-0.0.5/.conanignore

@@ -0,0 +1,14 @@
+README.md
+setup.py
+requirements.txt
+LICENSE
+.gitignore
+.editorconfig
+.pylintrc
+
+test/**
+src/**
+.github/**
+.venv/**
+.idea/**
+.pytest_cache/**

conan_auth_source_plugin-0.0.5/.editorconfig

@@ -0,0 +1,5 @@
+# top-most EditorConfig file
+root = true
+
+[*.md]
+max_line_length = 100

conan_auth_source_plugin-0.0.5/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish Python Package to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+# Least privilege: the workflow only needs to read the repo.
+permissions:
+  contents: read
+
+jobs:
+  build-and-publish:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    # Required for Trusted Publishing
+    environment:
+      name: pypi
+      url: https://pypi.org/p/conan-auth-source-plugin
+    permissions:
+      id-token: write  # MANDATORY: Allows GitHub to request the OIDC token from PyPI
+
+    steps:
+      #  https://github.com/actions/checkout
+      - name: Checkout code
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0   # setuptools_scm needs tags/history so the version tag can be used
+
+      # https://github.com/actions/setup-python
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build source and wheel distributions
+        run: python -m build
+
+      - name: Check distribution metadata
+        run: twine check dist/*
+
+      # https://github.com/pypa/gh-action-pypi-publish
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

conan_auth_source_plugin-0.0.5/.github/workflows/pylint.yml

@@ -0,0 +1,32 @@
+name: Pylint
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.14"]
+
+    steps:
+    #  https://github.com/actions/checkout
+    - uses: actions/checkout@v7
+
+    # https://github.com/actions/setup-python
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py') --fail-under=9

conan_auth_source_plugin-0.0.5/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

conan_auth_source_plugin-0.0.5/.idea/.gitignore

@@ -0,0 +1,13 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+
+/inspectionProfiles/profiles_settings.xml
+/inspectionProfiles/Project_Default.xml

conan_auth_source_plugin-0.0.5/.idea/.name

@@ -0,0 +1 @@
+conan-auth-source-plugin

conan_auth_source_plugin-0.0.5/.idea/conan-auth-source-plugin.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/test/micro" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/.venv" />
+      <excludeFolder url="file://$MODULE_DIR$/src/conan_auth_source_plugin.egg-info" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

conan_auth_source_plugin-0.0.5/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/conan-auth-source-plugin.iml" filepath="$PROJECT_DIR$/.idea/conan-auth-source-plugin.iml" />
+    </modules>
+  </component>
+</project>

conan_auth_source_plugin-0.0.5/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

conan_auth_source_plugin-0.0.5/.pylintrc

@@ -0,0 +1,18 @@
+
+[MASTER]
+# This directory contains example python that doesn't need to be linted.
+ignore-paths=
+    .*test/micro/.*
+    .*test/sample/.*
+
+[MAIN]
+load-plugins = pylint_per_file_ignores
+
+[FORMAT]
+max-line-length = 120
+
+
+[MESSAGES CONTROL]
+# Allow tests classes to have a single test method
+per-file-ignores =
+  **/test_*.py:too-few-public-methods

conan_auth_source_plugin-0.0.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Utilties, plugins and extesions for Conan package management
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

conan_auth_source_plugin-0.0.5/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: conan-auth-source-plugin
+Version: 0.0.5
+Summary: A python module to provide GitHub application authorisation for source downloads
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: conan<3.0,>=2.25
+Requires-Dist: packaging>=26.2
+Requires-Dist: PyGithub>=2.9.1
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# [conan-auth-source-plugin](https://github.com/conan-py/conan-auth-source-plugin)
+
+A Conan authentication source plugin, implemented as a python module. Conan supports both a *remote*
+and a *source* authentication, where the remotes are used for interacting with a remote for
+packages, whereas the *source* is used for getting source using the `get()` or `download()`
+method in a `conanfile.py`.
+
+# Installation
+
+Install the conan authentication source Python module, then install the plugin in that module
+into the conan installation.
+
+```shell
+python -m pip install conan-auth-source-plugin
+conan-auth-source-plugin-install
+```
+
+# Configuration
+
+This plugin uses the
+[`source_creditials.json`](https://docs.conan.io/2/reference/config_files/source_credentials.html)
+file for configuration. This file is marked as experimental at this stage. This module further
+experiments and extends its usage.
+
+**Note**: The conan source configuration code uses a first match (begins with) strategy with URLs.
+Thus, it is important to order the credentials in longest url first if there is any overlap in
+matching the URL being fetched with the configuration.
+
+## Sample
+
+```json
+{
+  "credentials": [
+    {
+      "url": "https://github.com/...",
+      "type": "github.app",
+      "app_id": "4459267",
+      "app_installation_id": "150620648",
+      "app_private_key" : "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
+    }
+  ]
+}
+```
+
+# Create App
+
+The following procedure can be used to create an application in github. This procedure requires an
+organisation owner, or a team member with app management permissions.
+
+This procedure is documented as a GitHub app that act on their 
+[own behalf](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps#github-apps-that-act-on-their-own-behalf).
+This requires an installation access token for authentication.
+
+1. Go to the organisation (or user) settings
+   
+   https://github.com/organizations/conan-py/settings/apps
+   https://github.com/<org name>/conan-py/settings/apps
+
+2. App settings
+   
+  - provide a github app name
+  - write a description
+  - add a homepage URL (e.g. to the organisation landing page), even though it isn't explicitly used
+  - disable web hook
+  - add repository permission 'Contents', set to 'Read-Only' 
+
+3. Once the app is created, the 'App ID' and the 'Client ID' (not used for this workflow) are known
+
+4. Go to the bottom of the application and generate a private key. This will
+   generate a 2048bit RSA key pair without a pass phrase. 
+
+5. On the side bar of the application, select the "Install App" menu item. Once installed
+   the installation id can be taken from the installation URL. For example if the installation
+   URL is 'https://github.com/organizations/conan-py/settings/installations/150620648', then the
+   installation id is 150620648. The installation id is not displayed in the web UI of github.
+
+# Why use this plugin module
+
+This module is a shift-left style strategy for authentication. Instead of using this pluing
+a build pipeline (or any Conan build) can pre-authenticate with all github organisation/repositores
+that *may* be needed during a build.
+
+This module goes half-way towards "authentication on demand". This is a concept where http
+authentication is only attempted by a client if a 
+[401 (Not authenticated)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/401)
+response is received, and the
+[`WWW-Authenticate` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/WWW-Authenticate)
+provides
+[authentication schemes](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml)
+that are semantically understood by the client. Once authenticated the client should reissue the
+http request with the new credentials.
+
+*Residual*: This plugin does not defer authentication until after it is needed. This is not
+supported by the Conan client.
+
+# Known issues
+
+- this implementation stores private keys by value in memory. e.g. if using AWS it
+  would be better to use a HSM or AWS KMS, but this would require an implementation
+  of the `github.Auth.Auth` class. Using AWS Secrets Manager at least stores the
+  key more securely at rest, even though it will be stored in memory non-securely.
+
+- when using the `get()` method in a `conanfile.py`, provide a filename parameter
+  with a representative name (e.g. 'archive.tgz') so that conan can write the download
+  to disk.  The filename should be expressed in the `conandat.yml`.
+
+# Development
+
+To install the plugin in a local Conan environment, the whole of the plugin repository
+can be installed, as the `.conanignore` will exclude everything except the plugin
+python file that thunks to the module.
+
+```shell
+conan config install .
+```
+
+Install the plugin Python for development as an editable module. From the root of the
+repository/project:
+
+```shell
+pip install --editable .
+```
+
+# Links
+
+ - https://pypi.org/project/conan-auth-source-plugin 
+ - https://github.com/conan-io/conan-extensions/tree/main
+ - https://docs.conan.io/2/reference/extensions/authorization_plugins.html
+ - https://docs.conan.io/2/reference/config_files/source_credentials.html
+ - https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app
+ - https://docs.github.com/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps
+
+## pygithub
+
+ - https://github.com/PyGithub/PyGithub/tree/main
+ - https://pygithub.readthedocs.io/en/stable/introduction.html
+
+# Appendices
+
+## github tarball URLs
+
+For getting source from a private github repo, use a URL/http request of the form: 
+
+```
+GET https://api.github.com/repos/{owner}/{repo}/tarball/{ref}
+Authorization: Bearer <installation_token>
+```