vdk-kerberos-auth

v0.3.1190994517

Versatile Data Kit SDK plugin adds Kerberos/GSSAPI support. For more information about how to use this package see README

Latest version published 2 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

71 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Limited

GitHub Stars: 410
Forks: 55
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package vdk-kerberos-auth, we found that it has been starred 410 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Feb 26, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like vdk-kerberos-auth is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 225
Open PR: 11
Last Release: 2 months ago
Last Commit: 9 hours ago

Further analysis of the maintenance status of vdk-kerberos-auth based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that vdk-kerberos-auth demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 40
Funding: No

With more than 10 contributors for the vdk-kerberos-auth repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.10.*, ==3.11.*, ==3.12.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 2 years
Latest Release: 2 months ago
Dependencies: 3 Direct / 27 Total
Versions: 26
Maintainers: 1
Wheels: No

Readme

monthly download count for vdk-kerberos-auth

The plugin provides GSSAPI Kerberos authentication on data job startup. The plugin also adds Kerberos/GSSAPI support for HTTP requests.

Usage

To install the plugin, run:

pip install vdk-kerberos-auth

After it's install what happens:

Upon installation and if KEYTAB_FILENAME and KEYTAB_PRINCIPAL are configured, it will try to authenticate ("kinit") at the start of very VDK command.
Then when a client needs to talk to kerberos provision server they would use KerberosClient class to generate header: With requests library, you'd use https://pypi.org/pypi/requests-kerberos. The following can be used if another http library does not support kerberos to generate Authorization header:

auth = KebrerosClient("http@server.fqdn.com")
headers['Authorization'] =  auth.read_kerberos_auth_header()

Known issues

The plugin dependency requests-kerberos==0.12.0 may fail to install on Ubuntu with the following error:

  src/kerberosbasic.h:17:10: fatal error: gssapi/gssapi.h: No such file or directory
     17 | #include 
        |          ^~~~~~~~~~~~~~~~~
  compilation terminated.

If this is the case, install libkrb5-dev with the command below and try reinstalling the plugin:

sudo apt-get install -y libkrb5-dev

Configuration

The following environment variables can be used to configure this plugin:

name	description
`KRB_AUTH`	Specifies the Kerberos authentication type to use. Possible values are 'minikerberos' and 'kinit'. If left empty, the authentication is disabled.
`KEYTAB_FILENAME`	Specifies the name of the keytab file. If left empty, the name of the keytab file is assumed to be the same as the name of the data job with '.keytab' suffix.
`KEYTAB_FOLDER`	Specifies the folder containing the keytab file. If left empty, the keytab file is expected to be located inside the data job folder.
`KEYTAB_PRINCIPAL`	Specifies the Kerberos principal. If left empty, the principal will be the job name prepended with 'pa__view_'.
`KEYTAB_REALM`	Specifies the Kerberos realm. This value is used only with the 'minikerberos' authentication type. The default value is 'default_realm'.
`KERBEROS_KDC_HOST`	Specifies the name of the Kerberos KDC (Key Distribution Center) host. This value is used only with the 'minikerberos' authentication type.

Testing

In order to run the tests you need pytest and docker and kerberos client (kadmin).

You can use helper script ../build-plugin.sh to build and test locally.

On Mac OS kadmin may miss some options needed. In this case you can use kadmin in docker to run the tests

export VDK_TEST_USE_KADMIN_DOCKER=true
cd /source/projects/vdk-plugins/vdk-kerberos-auth
../build-plugin.sh

vdk-kerberos-auth dependencies

pykerberos requests-kerberos vdk-core

FAQs

What is vdk-kerberos-auth?

Versatile Data Kit SDK plugin adds Kerberos/GSSAPI support. Visit Snyk Advisor to see a full health score report for vdk-kerberos-auth, including popularity, security, maintenance & community analysis.

Is vdk-kerberos-auth popular?

The python package vdk-kerberos-auth receives a total of 506 weekly downloads. As such, vdk-kerberos-auth popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is vdk-kerberos-auth well maintained?

We found that vdk-kerberos-auth demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is vdk-kerberos-auth safe to use?

While scanning the latest version of vdk-kerberos-auth, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 26 April-2024, at 12:49 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP