Merge pull request #54 from dmdhrumilmistry/dev

Add OWASP Notice in README

.github/workflows/dev-push.yml

@@ -0,0 +1,53 @@
+# name: "Dev Release: Build and Push Docker Image to DockerHub"
+
+# on:
+#   push:
+#     branches:
+#       - "dev"
+
+# jobs:
+#   push-base-docker-image:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Branch Checkout
+#         uses: actions/checkout@v2
+#       - name: Set up QEMU
+#         uses: docker/setup-qemu-action@v2
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v2
+#       - name: Login to Docker Hub
+#         uses: docker/login-action@v2
+#         with:
+#           username: ${{ secrets.DOCKERHUB_USERNAME }}
+#           password: ${{ secrets.DOCKERHUB_TOKEN }}
+#       - name: Build and push
+#         uses: docker/build-push-action@v3
+#         with:
+#           context: .
+#           file: ./DockerFiles/base-Dockerfile
+#           push: true
+#           tags: ${{ secrets.DOCKERHUB_USERNAME }}/offat-base:dev
+#           platforms: linux/amd64,linux/arm64
+
+#   push-cli-docker-image:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Branch Checkout
+#         uses: actions/checkout@v2
+#       - name: Set up QEMU
+#         uses: docker/setup-qemu-action@v2
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v2
+#       - name: Login to Docker Hub
+#         uses: docker/login-action@v2
+#         with:
+#           username: ${{ secrets.DOCKERHUB_USERNAME }}
+#           password: ${{ secrets.DOCKERHUB_TOKEN }}
+#       - name: Build and push
+#         uses: docker/build-push-action@v3
+#         with:
+#           context: .
+#           file: ./DockerFiles/cli-Dockerfile
+#           push: true
+#           tags: ${{ secrets.DOCKERHUB_USERNAME }}/offat:dev
+#           platforms: linux/amd64,linux/arm64

.github/workflows/pypi-publish.yml

@@ -1,39 +1,39 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+# # This workflow will upload a Python Package using Twine when a release is created
+# # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
 
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
+# # This workflow uses actions that are not certified by GitHub.
+# # They are provided by a third-party and are governed by
+# # separate terms of service, privacy policy, and support
+# # documentation.
 
-name: Upload offat Python Package to PyPi
+# name: Upload offat Python Package to PyPi
 
-on:
-  release:
-    types: [published]
+# on:
+#   release:
+#     types: [published]
 
-permissions:
-  contents: read
+# permissions:
+#   contents: read
 
-jobs:
-  deploy:
+# jobs:
+#   deploy:
 
-    runs-on: ubuntu-latest
+#     runs-on: ubuntu-latest
 
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+#     steps:
+#     - uses: actions/checkout@v3
+#     - name: Set up Python
+#       uses: actions/setup-python@v3
+#       with:
+#         python-version: '3.x'
+#     - name: Install dependencies
+#       run: |
+#         python -m pip install --upgrade pip
+#         pip install build
+#     - name: Build package
+#       run: python -m build
+#     - name: Publish package
+#       uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+#       with:
+#         user: __token__
+#         password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/release-push.yml

@@ -0,0 +1,48 @@
+# name: "Build and Push Docker Image to DockerHub"
+
+# on:
+#   release:
+#     types: [published]
+
+
+# jobs:
+#   push-base-docker-image:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Set up QEMU
+#         uses: docker/setup-qemu-action@v2
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v2
+#       - name: Login to Docker Hub
+#         uses: docker/login-action@v2
+#         with:
+#           username: ${{ secrets.DOCKERHUB_USERNAME }}
+#           password: ${{ secrets.DOCKERHUB_TOKEN }}
+#       - name: Build and push
+#         uses: docker/build-push-action@v3
+#         with:
+#           platforms: linux/amd64,linux/arm64
+#           push: true
+#           file: ./Dockerfiles/base-Dockerfile
+#           tags: ${{ secrets.DOCKERHUB_USERNAME }}/offat-base:latest
+
+
+#   push-cli-docker-image:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Set up QEMU
+#         uses: docker/setup-qemu-action@v2
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v2
+#       - name: Login to Docker Hub
+#         uses: docker/login-action@v2
+#         with:
+#           username: ${{ secrets.DOCKERHUB_USERNAME }}
+#           password: ${{ secrets.DOCKERHUB_TOKEN }}
+#       - name: Build and push
+#         uses: docker/build-push-action@v3
+#         with:
+#           platforms: linux/amd64,linux/arm64
+#           push: true
+#           file: ./Dockerfiles/cli-Dockerfile
+#           tags: ${{ secrets.DOCKERHUB_USERNAME }}/offat:latest

README.md

@@ -6,6 +6,12 @@ Automatically Tests for vulnerabilities after generating tests from openapi spec
 
 ![UnDocumented petstore API endpoint HTTP method results](./.images/tests/offat-v0.5.0.png)
 
+## Notice
+
+Project proposal has been approved by the OWASP Foundation. As a result, OFFAT will now be taken care of within the OWASP Repository and will go by the name OWASP OFFAT.
+
+For the most up-to-date releases and updates, be sure to check out the OWASP OFFAT Repository at this [link](https://github.com/OWASP/OFFAT).
+
 ## Security Checks
 
 - [X] Restricted HTTP Methods