github-app-auth 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7de14445c693279f09a86e7e1cd7c349c492b30a532b0951d49aed52eec90a96
+  data.tar.gz: b9d44e07749d0e017430f7614d6250ad1370f185839a0ed778573d39a6046e25
+SHA512:
+  metadata.gz: c10995031a23f2b0ee9b4fe6f6e5dbced77fe1fdcd9575d61f59de493a3d4b3190abff8212134e125d6e0bdb6cdc118e7a584141312372c0faa6aa8ef63b956f
+  data.tar.gz: 0db53d013d400c848debb9b5f38092128a8704d199947af608215a911d12bbf5586a945db23509c31692d1f4b232d22ec67afea1a4076e0fbe04f5c99006301f

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hortoncd@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Chris Horton
+
+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.

data/README.md

@@ -0,0 +1,112 @@
+# GitHub::App::Auth
+
+A gem to make (at least) some forms of GitHub App authentication easy.  It is built as an includable module, with the option of a class to
+instantiate if preferred.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github-app-auth'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install github-app-auth
+
+## Usage
+
+```
+require "github-app-auth"
+```
+
+Include the module in your class
+```
+include GitHub::App::Auth
+```
+
+Instantiate the AuthClass class and use the methods from there.
+```
+auth = GitHub::App:Auth::AuthClass.new
+```
+
+### Authenticating as an App
+
+See [the GitHub documentation](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app) for more information.
+
+Applicaiton authentication is required for most (all?) of the other methods of authentication.  To authenticate as the application, two
+secrets are required:
+
+- Private Key
+- Application ID
+
+The two supported methods are ENV variables, or setting the options in the `options` hash to be passed to the various method calls.
+
+#### Env Vars
+```
+GITHUB_APP_ID="123456"
+GITHUB_APP_PRIVATE_KEY="RSA Private Key ..."
+```
+
+#### Options hash
+```
+{
+  github_app_id: "123456",
+  github_app_private_key: "RSA Private Key ..."
+}
+```
+
+### Authenticating as an App Installation
+
+See [the GitHub documentation](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation#generating-an-installation-access-token) for more information.
+
+The examples are using the gem as an includable module, but can also be used with the available AuthClass class..
+
+Auth as an application installation for a repo and return an Octokit::Client.
+```
+client = app_installation_client("myaccount/myrepo")
+```
+
+Alternatively you can retrieve the token, and then set up your own GitHub client (Octokit or whatever you prefer) as needed.
+```
+token = app_instalation_token("myaccount/myrepo")
+client = Octokit::Client.new({ bearer_token: token, ... })
+```
+
+### Application Auth
+
+If you need to accomplish somehting other than authenticating as an application installation, you can use the app auth to get the initial client authenticated with the app JWT.
+```
+client = app_client
+```
+
+It's also possible to get just the JWT token for use with your own client setup.
+```
+token = app_token
+client = Octokit::Client.enw({ bearer_token: token, ... })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hortoncd/github-app-auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hortoncd/github-app-auth/blob/master/CODE_OF_CONDUCT.md).
+
+Don't forget to add/fix tests for your changes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GitHub::App::Auth project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hortoncd/github-app-auth/blob/master/CODE_OF_CONDUCT.md).

data/lib/github-app-auth/app.rb

@@ -0,0 +1,51 @@
+require "jwt"
+require "openssl"
+require_relative "client"
+
+module GitHub
+  module App
+    module Auth
+      def app_client(options = {})
+        client(:bearer_token => app_token(options))
+      end
+
+      # options: the following can be passed via the options hash.  if missing
+      #          they will be read from ENV.
+      # github_app_private_key: String, The private key for the GitHub app
+      # github_app_id: String, the app id for the GitHub app
+      def app_token(options = {})
+        # Private key contents
+        private_pem = app_private_key(options)
+        private_key = OpenSSL::PKey::RSA.new(private_pem)
+
+        # Generate the JWT
+        payload = {
+          # issued at time, 60 seconds in the past to allow for clock drift
+          iat: Time.now.to_i - 60,
+          # JWT expiration time (10 minute maximum)
+          exp: Time.now.to_i + (10 * 60),
+          # GitHub App's identifier
+          iss: app_id(options)
+        }
+
+        JWT.encode(payload, private_key, "RS256")
+      end
+
+      def app_id(options = {})
+        if options[:github_app_id]
+          options[:github_app_id]
+        else
+          ENV["GITHUB_APP_ID"]
+        end
+      end
+
+      def app_private_key(options = {})
+        if options[:github_app_private_key]
+          options[:github_app_private_key]
+        else
+          ENV["GITHUB_APP_PRIVATE_KEY"]
+        end
+      end
+    end
+  end
+end

data/lib/github-app-auth/app_installation.rb

@@ -0,0 +1,16 @@
+module GitHub
+  module App
+    module Auth
+      def app_installation_client(repo, options = {})
+        client(bearer_token: app_installation_token(repo, options))
+      end
+
+      def app_installation_token(repo, options = {})
+        application_client = app_client
+        installation = application_client.find_repository_installation(repo)
+        resp = application_client.create_app_installation_access_token(installation[:id])
+        resp[:token]
+      end
+    end
+  end
+end

data/lib/github-app-auth/client.rb

@@ -0,0 +1,11 @@
+require "octokit"
+
+module GitHub
+  module App
+    module Auth
+      def client(options = {})
+        Octokit::Client.new(options)
+      end
+    end
+  end
+end

data/lib/github-app-auth/version.rb

@@ -0,0 +1,7 @@
+module GitHub
+  module App
+    module Auth
+      VERSION = "0.2.0"
+    end
+  end
+end

data/lib/github-app-auth.rb

@@ -0,0 +1,13 @@
+require "github-app-auth/app"
+require "github-app-auth/app_installation"
+require "github-app-auth/version"
+
+module GitHub
+  module App
+    module Auth
+      class AuthClass
+        include GitHub::App::Auth
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: github-app-auth
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Horton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: GitHub App auth methods.
+email:
+- hortoncd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/github-app-auth.rb
+- lib/github-app-auth/app.rb
+- lib/github-app-auth/app_installation.rb
+- lib/github-app-auth/client.rb
+- lib/github-app-auth/version.rb
+homepage: https://github.com/hortoncd/github-app-auth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hortoncd/github-app-auth
+  source_code_uri: https://github.com/hortoncd/github-app-auth
+  changelog_uri: https://github.com/hortoncd/github-app-auth
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: GitHub App auth methods.
+test_files: []