├── .github
├── ISSUE_TEMPLATE
│ ├── bug_report.md
│ └── feature_request.md
└── workflows
│ ├── actions-template-health.yml
│ ├── actions-template-security.yml
│ └── python-publish.yml
├── .gitignore
├── .tool-versions
├── CHANGELOG.md
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LAST.gif
├── LICENSE
├── MANIFEST.in
├── README.md
├── SECURITY.md
├── example-outputs
├── agentic-full.md
└── non-agentic-full.md
├── logo.png
├── pyproject.toml
├── requirements.txt
├── setup.py
└── src
└── latio
├── __init__.py
├── core.py
└── workers.py
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: ''
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 |
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 |
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 |
26 | **Desktop (please complete the following information):**
27 | - OS: [e.g. iOS]
28 | - Browser [e.g. chrome, safari]
29 | - Version [e.g. 22]
30 |
31 | **Smartphone (please complete the following information):**
32 | - Device: [e.g. iPhone6]
33 | - OS: [e.g. iOS8.1]
34 | - Browser [e.g. stock browser, safari]
35 | - Version [e.g. 22]
36 |
37 | **Additional context**
38 | Add any other context about the problem here.
39 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature request
3 | about: Suggest an idea for this project
4 | title: ''
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 |
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 |
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 |
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 |
--------------------------------------------------------------------------------
/.github/workflows/actions-template-health.yml:
--------------------------------------------------------------------------------
1 | name: LAST
2 |
3 | on:
4 | pull_request:
5 | types: [opened, synchronize, reopened]
6 |
7 | jobs:
8 | LAST-Health-Scan:
9 | runs-on: ubuntu-latest
10 | steps:
11 |
12 | - uses: actions/checkout@v3
13 | with:
14 | fetch-depth: 0 # Fetch all history for all branches and tags
15 | ref: ${{ github.head_ref }}
16 |
17 | - name: Fetch target branch
18 | run: git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}
19 |
20 | - name: Set up Python 3.12
21 | uses: actions/setup-python@v3
22 | with:
23 | python-version: 3.12
24 |
25 | - name: Install dependencies
26 | run: |
27 | python -m pip install --upgrade pip
28 | pip install latio
29 |
30 | - name: Analyzing the code with LAST
31 | env:
32 | OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
33 | run: |
34 | latio partial-github . ${{ github.base_ref }} ${{ github.head_ref }} --health
35 |
36 |
--------------------------------------------------------------------------------
/.github/workflows/actions-template-security.yml:
--------------------------------------------------------------------------------
1 | name: LAST
2 |
3 | on:
4 | pull_request:
5 | types: [opened, synchronize, reopened]
6 |
7 | jobs:
8 | LAST-Security-Scan:
9 | runs-on: ubuntu-latest
10 | steps:
11 |
12 | - uses: actions/checkout@v3
13 | with:
14 | fetch-depth: 0 # Fetch all history for all branches and tags
15 | ref: ${{ github.head_ref }}
16 |
17 | - name: Fetch target branch
18 | run: git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}
19 |
20 | - name: Set up Python 3.12
21 | uses: actions/setup-python@v3
22 | with:
23 | python-version: 3.12
24 |
25 | - name: Install dependencies
26 | run: |
27 | python -m pip install --upgrade pip
28 | pip install latio
29 |
30 | - name: Analyzing the code with LAST
31 | env:
32 | OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
33 | run: |
34 | latio partial-github . ${{ github.base_ref }} ${{ github.head_ref }}
35 |
36 |
--------------------------------------------------------------------------------
/.github/workflows/python-publish.yml:
--------------------------------------------------------------------------------
1 | name: Upload Python Package
2 |
3 | on:
4 | release:
5 | types: [published]
6 |
7 | permissions:
8 | contents: read
9 |
10 | jobs:
11 | deploy:
12 |
13 | runs-on: ubuntu-latest
14 |
15 | steps:
16 | - uses: actions/checkout@v3
17 | - name: Set up Python
18 | uses: actions/setup-python@v3
19 | with:
20 | python-version: '3.x'
21 |
22 | - name: Install dependencies
23 | run: |
24 | python -m pip install --upgrade pip
25 | pip install build requests
26 |
27 | - name: Build package
28 | if: steps.check_version.outputs.exists != 'true'
29 | run: python -m build
30 |
31 | - name: Publish package
32 | if: steps.check_version.outputs.exists != 'true'
33 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
34 | with:
35 | user: __token__
36 | password: ${{ secrets.PYPI_API_TOKEN }}
37 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | share/python-wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 | MANIFEST
28 |
29 | # PyInstaller
30 | # Usually these files are written by a python script from a template
31 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
32 | *.manifest
33 | *.spec
34 |
35 | # Installer logs
36 | pip-log.txt
37 | pip-delete-this-directory.txt
38 |
39 | # Unit test / coverage reports
40 | htmlcov/
41 | .tox/
42 | .nox/
43 | .coverage
44 | .coverage.*
45 | .cache
46 | nosetests.xml
47 | coverage.xml
48 | *.cover
49 | *.py,cover
50 | .hypothesis/
51 | .pytest_cache/
52 | cover/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | .pybuilder/
76 | target/
77 |
78 | # Jupyter Notebook
79 | .ipynb_checkpoints
80 |
81 | # IPython
82 | profile_default/
83 | ipython_config.py
84 |
85 | # pyenv
86 | # For a library or package, you might want to ignore these files since the code is
87 | # intended to run in multiple environments; otherwise, check them in:
88 | # .python-version
89 |
90 | # pipenv
91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
94 | # install all needed dependencies.
95 | #Pipfile.lock
96 |
97 | # poetry
98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99 | # This is especially recommended for binary packages to ensure reproducibility, and is more
100 | # commonly ignored for libraries.
101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102 | #poetry.lock
103 |
104 | # pdm
105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106 | #pdm.lock
107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108 | # in version control.
109 | # https://pdm.fming.dev/#use-with-ide
110 | .pdm.toml
111 |
112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113 | __pypackages__/
114 |
115 | # Celery stuff
116 | celerybeat-schedule
117 | celerybeat.pid
118 |
119 | # SageMath parsed files
120 | *.sage.py
121 |
122 | # Environments
123 | .env
124 | .venv
125 | env/
126 | venv/
127 | ENV/
128 | env.bak/
129 | venv.bak/
130 |
131 | # Spyder project settings
132 | .spyderproject
133 | .spyproject
134 |
135 | # Rope project settings
136 | .ropeproject
137 |
138 | # mkdocs documentation
139 | /site
140 |
141 | # mypy
142 | .mypy_cache/
143 | .dmypy.json
144 | dmypy.json
145 |
146 | # Pyre type checker
147 | .pyre/
148 |
149 | # pytype static type analyzer
150 | .pytype/
151 |
152 | # Cython debug symbols
153 | cython_debug/
154 |
155 | # PyCharm
156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158 | # and can be added to the global gitignore or merged into this file. For a more nuclear
159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160 | #.idea/
161 |
--------------------------------------------------------------------------------
/.tool-versions:
--------------------------------------------------------------------------------
1 | Python 3.12.0
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ## [1.1.0] - 2024-02-18
4 | ### Added
5 | - Support for Google models
6 |
7 | ## [0.0.05] - 2024-01-15
8 | ### Added
9 | - New feature allowing users to specify model in command line.
10 | - Improved error handling for input validation.
11 | - Fixed partial scan logic
12 |
--------------------------------------------------------------------------------
/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @confusedcrib
2 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | * Demonstrating empathy and kindness toward other people
21 | * Being respectful of differing opinions, viewpoints, and experiences
22 | * Giving and gracefully accepting constructive feedback
23 | * Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | * Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | * The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | * Trolling, insulting or derogatory comments, and personal or political attacks
33 | * Public or private harassment
34 | * Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | * Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | info@latio.tech.
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to LAST
2 | We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3 |
4 | - Reporting a bug
5 | - Discussing the current state of the code
6 | - Submitting a fix
7 | - Proposing new features
8 | - Becoming a maintainer
9 |
10 | ## We Develop with Github
11 | We use github to host code, to track issues and feature requests, as well as accept pull requests.
12 |
13 | ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
14 | Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15 |
16 | 1. Fork the repo and create your branch from `master`.
17 | 2. If you've added code that should be tested, add tests. (Or write some, we currently don't have any :D)
18 | 3. If you've changed APIs, update the documentation.
19 | 4. Ensure the test suite passes.
20 | 5. Make sure your code lints.
21 | 6. Issue that pull request!
22 |
23 | ## Any contributions you make will be under the GPL 3.0 Software License
24 | In short, when you submit code changes, your submissions are understood to be under the same [GPL 3.0]https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
25 |
26 | ## Report bugs using Github's [issues](https://github.com/latiotech/LAST/issues)
27 | We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
28 |
29 | ## Write bug reports with detail, background, and sample code
30 | [This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
31 |
32 | **Great Bug Reports** tend to have:
33 |
34 | - A quick summary and/or background
35 | - Steps to reproduce
36 | - Be specific!
37 | - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what was seen.
38 | - What you expected would happen
39 | - What actually happens
40 | - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
41 |
42 | People *love* thorough bug reports. I'm not even kidding.
43 |
44 | ## License
45 | By contributing, you agree that your contributions will be licensed under its GPL 3.0 License.
46 |
47 | ## References
48 | This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
49 |
--------------------------------------------------------------------------------
/LAST.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/latiotech/LAST/901e631b334491fe67a0899e5af31af55b1ff100/LAST.gif
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include *.md LICENSE requirements.txt CHANGELOG
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
Latio Application Security Tester
2 |
3 | 
4 | 
5 | 
6 | 
7 | 
8 | [](https://discord.gg/k5aBQ55j5M)
9 | [](https://pypi.org/project/latio/)
10 |
11 | Use OpenAI or Gemini to scan your code for security and health issues from the CLI. Bring your own tokens. Options to scan full code, code changes, or in pipeline. Now with AI agents for deeper analysis and automated fixes.
12 | 
13 |
14 |
15 |
16 | [About Latio](https://latio.tech)
17 | [Find Security Tools](https://list.latio.tech)
18 |
19 | - [Install](#Install)
20 | - [How to Run Locally](#how-to-run-locally)
21 | - [How to Run in Pipeline](#how-to-run-in-pipeline)
22 | - [Command Line Options](#command-line-options)
23 |
24 | # Install
25 |
26 | ```bash
27 | pip install latio
28 |
29 | export OPENAI_API_KEY=xxx
30 |
31 | latio partial-agentic ./
32 | ```
33 | `partial-agentic` should be used on a new branch
34 | `full-agentic` can be used on an existing code base
35 |
36 | # How to Run Locally
37 |
38 | 1. Get your OpenAI key from [here](https://platform.openai.com/api-keys), and/or your Google API key [here](https://aistudio.google.com/app/apikey)
39 | 2. `export OPENAI_API_KEY=` and/or `export GEMINI_API_KEY=`
40 | 3. Scan only your changed files before merging with `latio partial /path/to/directory`. This uses the gpt-4o model by default. For Google, use `python latio partial /path/to/directory --model=gemini-pro`
41 | 4. Scan your full application with `latio full /path/to/directory`. This uses gpt-4o by default. Due to the context window, you may need to pass specific folders. For google, use `latio full /path/to/directory --model=gemini-pro`
42 | 5. Use the agentic analysis with `latio partial-agentic` or `latio full-agentic` for deeper code understanding and automated fixes
43 | 6. You can specify `--model` with the [model name from open ai](https://platform.openai.com/docs/models) to experiment
44 |
45 | # Known Issues
46 | 1. Haven't tested gemini for 2.5
47 | 2. github workflows currently don't work, but should be switched over to the agentic model
48 |
49 | # How to Run in Pipeline
50 |
51 | *Functionality currently busted*
52 |
53 | This will run OpenAI in pipeline against only your changed files. [Here's an example](https://github.com/latiotech/insecure-kubernetes-deployments/actions/runs/7619084201/job/20845086343) of what it looks like, it uses GPT-3.5 to scan only changed files, so it's relatively cheap.
54 |
55 | 1. Get your OpenAI token from [here](https://platform.openai.com/api-keys)
56 | 2. In your repository, go to `github.com/org/repo/settings/secrets/actions` and add a new Repository Secret called `OPENAI_API_KEY` with the value from OpenAI
57 | 3. Copy and paste the `.github/workflows/actions-template-security.yml` (or `-health` for health scan) into your own `.github/workflows/` folder.
58 |
59 | # Command Line Options
60 |
61 | ## `latio partial [--model ] [--health]`
62 |
63 | Scans only the files that have been changed in the specified directory.
64 |
65 | - ``: Path to the directory where your project is located.
66 | - `--model `: (Optional) Specifies the name of the OpenAI model to use for the scan. Defaults to `gpt-4o`
67 | - `--health`: (Optional) Runs a prompt focused on code optimization
68 |
69 | Example:
70 | ```bash
71 | latio partial /path/to/your/project --model gpt-4o --health
72 | ```
73 |
74 | ## `latio partial-agentic [--model ] [--health]`
75 |
76 | Scans only the files that have been changed in the specified directory using AI agents for deeper analysis.
77 |
78 | - ``: Path to the directory where your project is located.
79 | - `--model `: (Optional) Specifies the name of the OpenAI model to use for the scan. Defaults to `gpt-4o`
80 | - `--health`: (Optional) Runs a prompt focused on code optimization
81 |
82 | Example:
83 | ```bash
84 | latio partial-agentic /path/to/your/project --model gpt-4o --health
85 | ```
86 |
87 | ## `latio full [--model ] [--health]`
88 |
89 | Scans your entire codebase for security and health issues.
90 |
91 | - ``: Path to the directory where your project is located.
92 | - `--model `: (Optional) Specifies the name of the OpenAI model to use for the scan. Defaults to `gpt-4o`
93 | - `--health`: (Optional) Runs a prompt focused on code optimization
94 |
95 | Example:
96 | ```bash
97 | latio full /path/to/your/project --model gpt-4o --health
98 | ```
99 |
100 | ## `latio full-agentic [--model ] [--health]`
101 |
102 | Scans your entire codebase using AI agents for deeper analysis and automated fixes.
103 |
104 | - ``: Path to the directory where your project is located.
105 | - `--model `: (Optional) Specifies the name of the OpenAI model to use for the scan. Defaults to `gpt-4o`
106 | - `--health`: (Optional) Runs a prompt focused on code optimization
107 |
108 | Example:
109 | ```bash
110 | latio full-agentic /path/to/your/project --model gpt-4o --health
111 | ```
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | ## Supported Versions
4 |
5 | | Version | Supported |
6 | | ------- | ------------------ |
7 | | 0.0.x | :white_check_mark: |
8 |
9 | ## Reporting a Vulnerability
10 |
11 | Report vulnerabilities either by raising an [issue](https://github.com/latiotech/LAST/issues), or emailing info@latio.tech.
12 |
13 | Please be kind and don't report whatever SCA scanner you pointed at this thing; instead if you're concerned, encourage your developers to bump the version and submit a pull request.
14 |
15 | If you've discovered a legitimate vulnerability that you can personally reproduce or discuss as a possible exploit, we're happy to hear about it.
16 |
--------------------------------------------------------------------------------
/example-outputs/agentic-full.md:
--------------------------------------------------------------------------------
1 | Here's a summary of the security issues found:
2 |
3 | 1. **Environment Variables Exposure**:
4 | - **File**: `./src/latio/core.py`
5 | - **Lines**: 27, 28
6 | - **Issue**: API keys are accessed directly from environment variables without additional security measures.
7 | - **Fix**: Use a secure configuration management tool like `python-decouple` or `dotenv` to manage sensitive data. For example, load keys with `config('API_KEY', default='')`.
8 |
9 | 2. **Subprocess Use**:
10 | - **File**: `./src/latio/core.py`
11 | - **Lines**: 40, 119, 132
12 | - **Issue**: Direct use of `subprocess` can lead to command injection if inputs are not validated.
13 | - **Fix**: Use the `subprocess.run()` method with `shell=False` and input validation. For example:
14 | ```python
15 | subprocess.run(["git", "diff", "--name-status", base_ref, head_ref], check=True, text=True)
16 | ```
17 |
18 | 3. **Error Handling**:
19 | - **Files**: `./src/latio/core.py`, `./src/latio/workers.py`
20 | - **Lines**: Multiple instances
21 | - **Issue**: Numerous try-except blocks lack specific error handling, which may hide issues.
22 | - **Fix**: Implement specific exception handling and logging. Use logging libraries to capture errors rather than print statements.
23 |
24 | 4. **Open Files Without Validation**:
25 | - **File**: `./src/latio/workers.py`
26 | - **Lines**: 27, 74, 149, 173
27 | - **Issue**: Files are opened without validating the existence or type, which might result in unexpected behavior.
28 | - **Fix**: Validate or sanitize inputs and handle errors appropriately. Use `os.path.exists()` before opening files.
29 |
30 | 5. **Git Command Execution**:
31 | - **File**: `./src/latio/core.py`
32 | - **Lines**: 61, 178
33 | - **Issue**: Running git commands using `subprocess` without validation of input can be insecure.
34 | - **Fix**: Ensure paths and inputs are validated and sanitized before executing git commands. Use safer methods of interfacing with Git, such as using GitPython.
35 |
36 | These fixes will help enhance the security of the application. Let me know if you need further assistance!
--------------------------------------------------------------------------------
/example-outputs/non-agentic-full.md:
--------------------------------------------------------------------------------
1 | The code provided for review consists of multiple files with various functions related to analyzing and scanning code for security and health issues using OpenAI and Google Gemini APIs. Here are some potential security vulnerabilities and issues that should be addressed:
2 |
3 | 1. **Hardcoded Credentials**:
4 | - There might be a risk of exposing API keys if they are hardcoded or improperly managed. Ensure that `OPENAI_API_KEY`, `GITHUB_TOKEN`, and `GEMINI_API_KEY` are securely managed and not hardcoded in the source code. Use environment variables or a secure vault.
5 |
6 | 2. **Command Injection**:
7 | - Functions like `get_changed_files`, `get_line_changes`, and `get_changed_files_github` use `subprocess.check_output` to execute Git commands. Ensure that any inputs to these commands are properly sanitized to prevent command injection attacks.
8 |
9 | 3. **File Handling**:
10 | - When reading files (especially in `analyze_code_context` and `gather_full_code` functions), ensure that the file paths are validated and sanitized to prevent directory traversal attacks.
11 | - Use context managers (`with` statements) for file operations to ensure files are properly closed after operations.
12 |
13 | 4. **Error Handling**:
14 | - There are several places where exceptions are caught broadly using `except Exception as e`. This can mask other issues and make debugging difficult. Consider catching specific exceptions and handling them appropriately.
15 | - In functions like `get_line_changes`, ensure that all potential exceptions are logged or handled to prevent silent failures.
16 |
17 | 5. **Injection Risks in AI Models**:
18 | - When sending data to AI models (e.g., in `full_sec_scan`, `partial_sec_scan`), ensure that the data is properly sanitized and does not include sensitive information. AI models can inadvertently leak information if prompts are not correctly managed.
19 |
20 | 6. **Logging Sensitive Information**:
21 | - Avoid logging sensitive information such as file contents or API responses unless absolutely necessary. Ensure that logs are properly secured and access-controlled.
22 |
23 | 7. **Concurrency Issues**:
24 | - Functions that use `asyncio` should be properly managed to prevent concurrency issues. Ensure that any shared resources are protected against race conditions.
25 |
26 | 8. **Use of External Libraries**:
27 | - Ensure that all external libraries and dependencies are up to date with the latest security patches. Regularly audit dependencies for known vulnerabilities using tools like `pip-audit`.
28 |
29 | 9. **Security Headers and Best Practices**:
30 | - When making HTTP requests (e.g., using `requests.get`), consider using security headers like `User-Agent` and ensure SSL/TLS verification is enforced.
31 |
32 | 10. **Data Exposure**:
33 | - Be cautious about exposing detailed application data in AI prompts or external requests. Use redaction or summarization where possible to minimize information leakage.
34 |
35 | By addressing the above issues, you can enhance the security posture of the application. Additionally, consider conducting regular security reviews and penetration testing to identify further vulnerabilities.
--------------------------------------------------------------------------------
/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/latiotech/LAST/901e631b334491fe67a0899e5af31af55b1ff100/logo.png
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["setuptools", "wheel"]
3 | build-backend = "setuptools.build_meta"
4 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | openai==1.70.0
2 | PyGithub==2.1.1
3 | Requests==2.31.0
4 | google-generativeai==0.3.2
5 | pylance==0.9.17
6 | ipython==8.21.0
7 | openai-agents==0.0.7
8 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup
2 | from pathlib import Path
3 |
4 | this_directory = Path(__file__).parent
5 | long_description = (this_directory / "README.md").read_text()
6 | with open('requirements.txt') as f:
7 | requirements_txt = f.read().splitlines()
8 |
9 | setup(
10 | name='latio',
11 | version='v1.2.7',
12 | url='https://github.com/latiotech/LAST',
13 | license='GPL-3.0 license',
14 | author='James Berthoty',
15 | author_email='james@latio.tech',
16 | description='Latio Application Security Tester - Uses OpenAPI to scan for security issues in code changes',
17 | install_requires=requirements_txt,
18 | entry_points = {
19 | 'console_scripts': ['latio = latio.core:main'],
20 | },
21 | long_description=long_description,
22 | long_description_content_type='text/markdown',
23 | classifiers=[
24 | 'Development Status :: 5 - Production/Stable',
25 | 'Intended Audience :: Developers',
26 | 'Topic :: Software Development :: Libraries :: Python Modules',
27 | 'Topic :: Security',
28 | 'Programming Language :: Python :: 3',
29 | 'Programming Language :: Python :: 3.8',
30 | 'Programming Language :: Python :: 3.9',
31 | 'Programming Language :: Python :: 3.10',
32 | 'Programming Language :: Python :: 3.11',
33 | ],
34 | python_requires='>=3.8',
35 | package_dir={'': 'src'},
36 | packages=['latio'],
37 | include_package_data=True,
38 | )
39 |
--------------------------------------------------------------------------------
/src/latio/__init__.py:
--------------------------------------------------------------------------------
1 | from .core import main
2 |
--------------------------------------------------------------------------------
/src/latio/core.py:
--------------------------------------------------------------------------------
1 | from openai import OpenAI
2 | from agents import Agent, Runner
3 | from pydantic import BaseModel
4 | import os
5 | import sys
6 | import requests
7 | from github import Github
8 | import subprocess
9 | import argparse
10 | import pathlib
11 | import textwrap
12 | import google.generativeai as genai
13 | from IPython.display import display
14 | from IPython.display import Markdown
15 | import asyncio
16 | try:
17 | from . import workers
18 | except ImportError:
19 | import workers
20 |
21 | def to_markdown(text):
22 | text = text.replace('•', ' *')
23 | return textwrap.indent(text, '> ', predicate=lambda _: True)
24 |
25 | google_models = ['gemini-pro']
26 |
27 | client = OpenAI(api_key=os.environ.get('OPENAI_API_KEY'))
28 | githubkey = os.environ.get('GITHUB_TOKEN')
29 | googleapikey = os.environ.get('GEMINI_API_KEY')
30 |
31 | genai.configure(api_key=googleapikey)
32 |
33 | def get_changed_files_github(directory, base_ref, head_ref):
34 | """
35 | Returns a list of files that have been changed in the pull request, excluding deleted files.
36 | """
37 | changed_files = []
38 | try:
39 | os.chdir(directory)
40 | result = subprocess.check_output(["git", "diff", "--name-status", f"{base_ref}...{head_ref}"], text=True)
41 | lines = result.strip().split('\n')
42 | for line in lines:
43 | parts = line.split(None, 1)
44 | if len(parts) == 2:
45 | status, file_path = parts
46 | if status != 'D':
47 | changed_files.append(file_path)
48 | else:
49 | raise ValueError(f"Unexpected format in git diff output: '{line}'")
50 | except subprocess.CalledProcessError as e:
51 | print(f"Error getting changed files: {e}")
52 | return changed_files
53 |
54 |
55 | def get_changed_files(directory):
56 | """
57 | Returns a list of files that have been changed locally.
58 | """
59 | changed_files = []
60 | try:
61 | original_dir = os.getcwd()
62 | os.chdir(directory)
63 | print(f"Executing git commands in {os.getcwd()}")
64 |
65 | # Check if this is a git repository
66 | try:
67 | subprocess.check_output(["git", "rev-parse", "--is-inside-work-tree"], text=True)
68 | except subprocess.CalledProcessError:
69 | print(f"Error: {directory} is not a git repository")
70 | os.chdir(original_dir)
71 | return []
72 |
73 | try:
74 | # Get unstaged changes
75 | unstaged = subprocess.check_output(["git", "diff", "--name-only"], text=True).strip().split('\n')
76 | # Get staged changes
77 | staged = subprocess.check_output(["git", "diff", "--staged", "--name-only"], text=True).strip().split('\n')
78 | # Get untracked files
79 | untracked = subprocess.check_output(["git", "ls-files", "--others", "--exclude-standard"], text=True).strip().split('\n')
80 |
81 | # Combine all changes, removing empty entries
82 | all_changes = [f for f in unstaged + staged + untracked if f]
83 | changed_files = list(set(all_changes)) # Remove duplicates
84 |
85 | print(f"Unstaged: {len([f for f in unstaged if f])}, Staged: {len([f for f in staged if f])}, Untracked: {len([f for f in untracked if f])}")
86 |
87 | except subprocess.CalledProcessError as e:
88 | print(f"Error executing git command: {e}")
89 |
90 | print(f"Detected {len(changed_files)} changed files")
91 | return changed_files
92 | except Exception as e:
93 | print(f"Unexpected error getting changed files: {e}")
94 | import traceback
95 | traceback.print_exc()
96 | return []
97 | finally:
98 | if 'original_dir' in locals():
99 | os.chdir(original_dir)
100 |
101 | def get_line_changes(directory, changed_files):
102 | """
103 | Returns a string containing colored line changes from the changed files.
104 | """
105 | original_dir = os.getcwd()
106 | line_changes = ""
107 | try:
108 | os.chdir(directory)
109 | print(f"Getting line changes in {os.getcwd()}")
110 |
111 | for file in changed_files:
112 | print(f"Processing file: {file}")
113 |
114 | # Track if we've found changes for this file
115 | found_changes = False
116 |
117 | # Try unstaged changes first
118 | try:
119 | result = subprocess.check_output(["git", "diff", "--", file], text=True)
120 | if result.strip():
121 | print(f"Found unstaged changes for {file}")
122 | line_changes += f"\nFile: {color_text(file, '34')}\n"
123 | for line in result.splitlines():
124 | line_changes += color_diff_line(line) + "\n"
125 | found_changes = True
126 | except subprocess.CalledProcessError as e:
127 | print(f"Error getting unstaged diff for {file}: {e}")
128 |
129 | # If no unstaged changes, try staged changes
130 | if not found_changes:
131 | try:
132 | result = subprocess.check_output(["git", "diff", "--staged", "--", file], text=True)
133 | if result.strip():
134 | print(f"Found staged changes for {file}")
135 | line_changes += f"\nFile: {color_text(file, '34')}\n"
136 | for line in result.splitlines():
137 | line_changes += color_diff_line(line) + "\n"
138 | found_changes = True
139 | except subprocess.CalledProcessError as e:
140 | print(f"Error getting staged diff for {file}: {e}")
141 |
142 | # Check if this is an untracked file (new file)
143 | if not found_changes:
144 | try:
145 | untracked_files = subprocess.check_output(["git", "ls-files", "--others", "--exclude-standard"], text=True).strip().split('\n')
146 | if file in untracked_files:
147 | print(f"{file} is an untracked file, including full content")
148 | try:
149 | with open(file, 'r') as f:
150 | content = f.read()
151 |
152 | # Format as a diff for a new file
153 | line_changes += f"\nFile: {color_text(file, '34')} (New File)\n"
154 | line_changes += f"diff --git a/{file} b/{file}\n"
155 | line_changes += f"new file mode 100644\n"
156 | line_changes += f"--- /dev/null\n"
157 | line_changes += f"+++ b/{file}\n"
158 |
159 | # Add each line with a + to indicate addition
160 | for line in content.splitlines():
161 | line_changes += color_diff_line("+" + line) + "\n"
162 |
163 | found_changes = True
164 | except Exception as e:
165 | print(f"Error reading untracked file {file}: {e}")
166 | except subprocess.CalledProcessError as e:
167 | print(f"Error checking untracked files: {e}")
168 |
169 | # If still no changes found, this is unexpected
170 | if not found_changes:
171 | print(f"Warning: No changes found for {file} despite it being in the changed files list")
172 | try:
173 | with open(file, 'r') as f:
174 | content = f.read()
175 | line_changes += f"\nFile: {color_text(file, '34')} (Full content - no diff available)\n"
176 | for line in content.splitlines():
177 | line_changes += line + "\n"
178 | except Exception as e:
179 | print(f"Error reading file {file}: {e}")
180 |
181 | except Exception as e:
182 | print(f"Unexpected error in get_line_changes: {e}")
183 | import traceback
184 | traceback.print_exc()
185 | finally:
186 | os.chdir(original_dir)
187 |
188 | if not line_changes.strip():
189 | print("Warning: No line changes were detected for any files")
190 |
191 | return line_changes
192 |
193 | def full_sec_scan(application_summary, model):
194 | """
195 | This function sends a code snippet to OpenAI's API to check for security vulnerabilities.
196 | """
197 | if model in google_models:
198 | try:
199 | model = genai.GenerativeModel('gemini-pro')
200 | response = model.generate_content("You are an application security expert, skilled in explaining complex programming vulnerabilities with simplicity. You will receive the full code for an application. Your task is to review the code for security vulnerabilities and suggest improvements. Don't overly focus on one file, and instead provide the top security concerns based on what you think the entire application is doing. Here is the code: " + application_summary)
201 | message = to_markdown(response.text)
202 | return message
203 | except Exception as e:
204 | return f"Error occurred: {e}"
205 | else:
206 | try:
207 | response = client.chat.completions.create(
208 | model=model,
209 | messages=[
210 | {"role": "system", "content": "You are an application security expert."},
211 | {"role": "user", "content": "Please review the following code for security vulnerabilities: " + application_summary}
212 | ],
213 | max_tokens=1000,
214 | temperature=0.7,
215 | )
216 | message = response.choices[0].message.content.strip()
217 | return message
218 | except Exception as e:
219 | return f"Error occurred: {e}"
220 |
221 | def full_health_scan(application_summary, model):
222 | """
223 | This function sends a code snippet to OpenAI's API to check for optimizations.
224 | """
225 | if model in google_models:
226 | try:
227 | model = genai.GenerativeModel('gemini-pro')
228 | response = model.generate_content("You are a world class 10x developer who gives kind suggestions for remediating code smells and optimizing for big O complexity. You will receive the full code for an application. Your task is to review the code for optimizations and improvements, calling out the major bottlenecks. Don't overly focus on one file, and instead provide the best optimizations based on what you think the entire application is doing. Here is the code: " + application_summary)
229 | message = to_markdown(response.text)
230 | return message
231 | except Exception as e:
232 | return f"Error occurred: {e}"
233 | else:
234 | try:
235 | response = client.chat.completions.create(
236 | model=model,
237 | messages=[
238 | {"role": "system", "content": "You are a world class 10x developer."},
239 | {"role": "user", "content": "Please review the following code for optimizations: " + application_summary}
240 | ],
241 | max_tokens=1000,
242 | temperature=0.7,
243 | )
244 | message = response.choices[0].message.content.strip()
245 | return message
246 | except Exception as e:
247 | return f"Error occurred: {e}"
248 |
249 | def full_scan(directory, model, health=False):
250 | """
251 | Scans all files in the specified directory holistically for security issues.
252 | """
253 | application_summary = ""
254 | for root, dirs, files in os.walk(directory):
255 | for file in files:
256 | file_path = os.path.join(root, file)
257 | try:
258 | with open(file_path, 'r') as f:
259 | application_summary += f"\n\nFile: {file}\n"
260 | application_summary += f.read()
261 | except UnicodeDecodeError:
262 | try:
263 | with open(file_path, 'r', encoding='latin-1') as f:
264 | application_summary += f"\n\nFile: {file}\n"
265 | application_summary += f.read()
266 | except Exception as e:
267 | print(f"Error reading {file_path}: {e}")
268 | if health:
269 | result = full_health_scan(application_summary, model)
270 | else:
271 | result = full_sec_scan(application_summary, model)
272 | return result
273 |
274 | async def full_agent_scan(directory, model, health=False):
275 | """
276 | Scans files changed locally and includes detailed line changes for security issues.
277 | """
278 | # Common patterns to ignore
279 | ignore_patterns = {
280 | 'directories': [
281 | 'node_modules',
282 | '.git',
283 | '__pycache__',
284 | '.pytest_cache',
285 | 'dist',
286 | 'build',
287 | 'venv',
288 | '.venv',
289 | 'env',
290 | '.env',
291 | 'target',
292 | 'out',
293 | 'coverage',
294 | '.next',
295 | '.nuxt',
296 | '.output',
297 | '.cache',
298 | '.idea',
299 | '.vscode',
300 | '.DS_Store',
301 | '.gradle'
302 | ],
303 | 'files': [
304 | '*.pyc',
305 | '*.pyo',
306 | '*.pyd',
307 | '*.so',
308 | '*.dll',
309 | '*.dylib',
310 | '*.exe',
311 | '*.class',
312 | '*.jar',
313 | '*.war',
314 | '*.ear',
315 | '*.zip',
316 | '*.tar.gz',
317 | '*.tar',
318 | '*.gz',
319 | '*.rar',
320 | '*.7z',
321 | '*.pdf',
322 | '*.doc',
323 | '*.docx',
324 | '*.xls',
325 | '*.xlsx',
326 | '*.ppt',
327 | '*.pptx',
328 | '*.jpg',
329 | '*.jpeg',
330 | '*.png',
331 | '*.gif',
332 | '*.ico',
333 | '*.svg',
334 | '*.woff',
335 | '*.woff2',
336 | '*.ttf',
337 | '*.eot',
338 | '*.mp3',
339 | '*.mp4',
340 | '*.wav',
341 | '*.ogg',
342 | '*.webm',
343 | '*.mov',
344 | '*.avi',
345 | '*.mkv',
346 | '*.log',
347 | '*.lock',
348 | '*.min.js',
349 | '*.min.css',
350 | '*.bundle.js',
351 | '*.bundle.css'
352 | ]
353 | }
354 |
355 | def should_ignore(path):
356 | # Check if path contains any ignored directory
357 | for pattern in ignore_patterns['directories']:
358 | if pattern in path.split(os.sep):
359 | return True
360 |
361 | # Check if file matches any ignored pattern
362 | for pattern in ignore_patterns['files']:
363 | if path.endswith(pattern.replace('*', '')):
364 | return True
365 |
366 | return False
367 |
368 | file_list = []
369 | total_chars = 0
370 | for root, dirs, files in os.walk(directory):
371 | # Remove ignored directories from dirs to prevent walking into them
372 | dirs[:] = [d for d in dirs if not should_ignore(os.path.join(root, d))]
373 |
374 | for file in files:
375 | file_path = os.path.join(root, file)
376 | if should_ignore(file_path):
377 | continue
378 |
379 | try:
380 | with open(file_path, 'r', encoding='utf-8') as f:
381 | content = f.read()
382 | char_count = len(content)
383 | file_list.append(f"{file_path} ({char_count} chars)")
384 | total_chars += char_count
385 | except UnicodeDecodeError:
386 | # Try with a different encoding if UTF-8 fails
387 | try:
388 | with open(file_path, 'r', encoding='latin-1') as f:
389 | content = f.read()
390 | char_count = len(content)
391 | file_list.append(f"{file_path} ({char_count} chars)")
392 | total_chars += char_count
393 | except Exception as e:
394 | file_list.append(f"{file_path} (error reading file: {str(e)})")
395 | except Exception as e:
396 | file_list.append(f"{file_path} (error reading file: {str(e)})")
397 |
398 | application_summary = f"Total characters: {total_chars}\n\nFiles:\n" + "\n".join(file_list)
399 |
400 | prompt = "Here are all of the files in this application: " + application_summary
401 | try:
402 | # Try with proper error handling
403 | print("Sending to context agent...")
404 | security_tool = workers.security_agent.as_tool(
405 | tool_name="security_agent",
406 | tool_description="Specialist in evaluating code for security issues."
407 | )
408 | health_tool = workers.health_agent.as_tool(
409 | tool_name="health_agent",
410 | tool_description="Specialist in evaluating code for health issues."
411 | )
412 | full_context_code_gatherer = workers.full_context_agent_code.as_tool(
413 | tool_name="full_context_agent_code",
414 | tool_description="Specialist in evaluating code for security and health issues."
415 | )
416 | full_context_with_tools = workers.full_context_file_parser.clone(tools=[full_context_code_gatherer, security_tool, health_tool, workers.gather_full_code])
417 | result = await Runner.run(full_context_with_tools, prompt)
418 | result = result.final_output
419 |
420 | print("Received response from full context agent")
421 |
422 | return result
423 | except Exception as e:
424 | print(f"Error in context agent: {e}")
425 | import traceback
426 | traceback.print_exc()
427 | return color_text(f"Error during analysis: {str(e)}", "31")
428 |
429 |
430 | def partial_sec_scan(application_summary, model):
431 | """
432 | This function sends a code snippet to OpenAI's API to check for security vulnerabilities.
433 | """
434 | if model in google_models:
435 | try:
436 | model = genai.GenerativeModel('gemini-pro')
437 | response = model.generate_content("You are an application security expert, skilled in explaining complex programming vulnerabilities with simplicity. You will receive changed code as part of a pull request, followed by the rest of the file. Your task is to review the code change for security vulnerabilities and suggest improvements. Pay attention to if the code is getting added or removed indicated by the + or - at the beginning of the line. Suggest specific code fixes where applicable. Focus the most on the code that is being changed, which starts with Detailed Line Changes, instead of Changed Files. Here is the code: " + application_summary)
438 | message = to_markdown(response.text)
439 | return message
440 | except Exception as e:
441 | return f"Error occurred: {e}"
442 | else:
443 | try:
444 | response = client.chat.completions.create(
445 | model=model,
446 | messages=[
447 | {"role": "system", "content": "You are an application security expert."},
448 | {"role": "user", "content": "Please review the following code changes for security vulnerabilities: " + application_summary}
449 | ],
450 | max_tokens=1000,
451 | temperature=0.7,
452 | )
453 | message = response.choices[0].message.content.strip()
454 | return message
455 | except Exception as e:
456 | return f"Error occurred: {e}"
457 |
458 | def partial_health_scan(application_summary, model):
459 | """
460 | This function sends a code snippet to OpenAI's API to check for code optimizations.
461 | """
462 | if model in google_models:
463 | try:
464 | model = genai.GenerativeModel('gemini-pro')
465 | response = model.generate_content("You are a world class 10x developer who gives kind suggestions for remediating code smells and optimizing for big O complexity. You will receive changed code as part of a pull request, followed by the rest of the file. Your task is to review the changed code for optimizations and improvements, calling out any potential slowdowns. Pay attention to if the code is getting added or removed indicated by the + or - at the beginning of the line. Focus the most on the code that is being changed, which starts with Detailed Line Changes, instead of Changed Files. Here is the code: " + application_summary)
466 | message = to_markdown(response.text)
467 | return message
468 | except Exception as e:
469 | return f"Error occurred: {e}"
470 | else:
471 | try:
472 | response = client.chat.completions.create(
473 | model=model,
474 | messages=[
475 | {"role": "system", "content": "You are a world class 10x developer."},
476 | {"role": "user", "content": "Please review the following code changes for optimizations: " + application_summary}
477 | ],
478 | max_tokens=1000,
479 | temperature=0.7,
480 | )
481 | message = response.choices[0].message.content.strip()
482 | return message
483 | except Exception as e:
484 | return f"Error occurred: {e}"
485 |
486 | def github_scan(repo_name, pr_number, github_token, model, health=False):
487 | """
488 | Scans files changed in the specified GitHub pull request holistically.
489 | """
490 | g = Github(github_token)
491 | repo = g.get_repo(repo_name)
492 | pr = repo.get_pull(pr_number)
493 | files = pr.get_files()
494 |
495 | changes_summary = ""
496 | for file in files:
497 | changes_summary += f"\n\nFile: {file.filename}\n"
498 | url = file.raw_url
499 | response = requests.get(url)
500 | if response.status_code == 200:
501 | changes_summary += response.text
502 | else:
503 | print(f"Failed to fetch {file.filename}")
504 | if health:
505 | result = partial_health_scan(changes_summary, model)
506 | else:
507 | result = partial_sec_scan(changes_summary, model)
508 | return result
509 |
510 | def partial_scan_github(directory, base_ref, head_ref, model, health=False):
511 | """
512 | Scans files changed locally and includes detailed line changes for security issues.
513 | """
514 | changed_files = get_changed_files_github(directory, base_ref, head_ref)
515 | line_changes = get_line_changes(directory, changed_files)
516 | changes_summary = "Detailed Line Changes:\n" + line_changes + "\n\nChanged Files:\n"
517 |
518 | for file_path in changed_files:
519 | if file_path:
520 | try:
521 | with open(file_path, 'r') as f:
522 | changes_summary += f"\nFile: {file_path}\n"
523 | changes_summary += f.read()
524 | except UnicodeDecodeError:
525 | try:
526 | with open(file_path, 'r', encoding='latin-1') as f:
527 | changes_summary += f"\nFile: {file_path}\n"
528 | changes_summary += f.read()
529 | except Exception as e:
530 | print(f"Error reading {file_path}: {e}")
531 | else:
532 | print("No changed files to scan.")
533 | return
534 | if changes_summary:
535 | if health:
536 | result = partial_health_scan(changes_summary, model)
537 | else:
538 | result = partial_sec_scan(changes_summary, model)
539 | return result
540 | else:
541 | return "No changed files to scan."
542 | return result
543 | else:
544 | return "No changed files to scan."
545 |
546 | def color_text(text, color_code):
547 | """
548 | Returns the text wrapped in ANSI color codes.
549 | """
550 | return f"\033[{color_code}m{text}\033[0m"
551 |
552 | def color_diff_line(line):
553 | """
554 | Returns the line wrapped in ANSI color codes based on diff output.
555 | """
556 | if line.startswith('+'):
557 | return color_text(line, "32")
558 | elif line.startswith('-'):
559 | return color_text(line, "31")
560 | return line
561 |
562 | async def partial_agent_scan(directory, model, health=False):
563 | """
564 | Scans files changed locally and includes detailed line changes for security issues.
565 | """
566 | # Retrieve names of changed files
567 | changed_files = get_changed_files(directory)
568 | if changed_files is None or not changed_files:
569 | print("Debug: get_changed_files returned:", changed_files)
570 | return color_text("You haven't made any changes to test.", "31")
571 |
572 | # Print names of changed files in blue
573 | print(color_text("Changed Files:", "34"))
574 | for file_path in changed_files:
575 | print(color_text(file_path, "34"))
576 |
577 | # Retrieve and print changed lines of code in green
578 | line_changes = get_line_changes(directory, changed_files)
579 | if not line_changes:
580 | return color_text("No changed lines to scan.", "31") # Red text for errors
581 | print(color_text("\nChanged Code for Analysis:\n", "32") + line_changes) # Don't double-color the lines
582 |
583 | # Prepare the summary for scanning
584 | changes_summary = "Detailed Line Changes:\n" + line_changes + "\n\nChanged Files:\n" + "\n".join(changed_files)
585 | print("Starting partial scan...")
586 |
587 | # Fix: Add space between prompt and content
588 | prompt = "Please analyze these code changes: \n\n" + changes_summary
589 |
590 | try:
591 | # Try with proper error handling
592 | print("Sending to context agent...")
593 | security_tool = workers.security_agent.as_tool(
594 | tool_name="security_agent",
595 | tool_description="Specialist in evaluating code for security issues."
596 | )
597 | health_tool = workers.health_agent.as_tool(
598 | tool_name="health_agent",
599 | tool_description="Specialist in evaluating code for health issues."
600 | )
601 | context_with_tools = workers.context_agent.clone(tools=[security_tool, health_tool, workers.analyze_code_context])
602 | result = await Runner.run(context_with_tools, prompt)
603 | result = result.final_output
604 | print("Received response from context agent")
605 |
606 | return result
607 | except Exception as e:
608 | print(f"Error in context agent: {e}")
609 | import traceback
610 | traceback.print_exc()
611 | return color_text(f"Error during analysis: {str(e)}", "31")
612 |
613 | def partial_scan(directory, model, health=False):
614 | """
615 | Scans files changed locally and includes detailed line changes for security issues.
616 | """
617 | # Retrieve names of changed files
618 | changed_files = get_changed_files(directory)
619 | if changed_files is None:
620 | return color_text("You haven't made any changes to test.", "31")
621 |
622 | # Print names of changed files in blue
623 | print(color_text("Changed Files:", "34"))
624 | for file_path in changed_files:
625 | print(color_text(file_path, "34"))
626 |
627 | # Retrieve and print changed lines of code in green
628 | line_changes = get_line_changes(directory, changed_files)
629 | if not line_changes:
630 | return color_text("No changed lines to scan.", "31") # Red text for errors
631 | print(color_text("\nChanged Code for Analysis:\n", "32") + color_text(line_changes, "32")) # Green text
632 |
633 | # Prepare the summary for scanning
634 | changes_summary = "Detailed Line Changes:\n" + line_changes + "\n\nChanged Files:\n" + "\n".join(changed_files)
635 |
636 | # Send the summary for scanning
637 | if health:
638 | result = partial_health_scan(changes_summary, model)
639 | else:
640 | result = partial_sec_scan(changes_summary, model)
641 | return result
642 |
643 | def main():
644 | """
645 | Main function to perform full or partial security scanning.
646 | """
647 | # First, parse only the mode argument using sys.argv
648 | if len(sys.argv) < 2:
649 | print("Usage: latio [|]")
650 | sys.exit(1)
651 |
652 | mode = sys.argv[1]
653 |
654 | # Set the default model based on the mode
655 | default_model = 'gpt-4o' if mode == 'full' else 'gpt-4o'
656 | print("Running in mode:", mode, "with model:", default_model)
657 |
658 | # Set up argparse for the --model argument with the conditional default
659 | parser = argparse.ArgumentParser(add_help=False)
660 | parser.add_argument('--model', type=str, default=default_model, help='Name of the model to use, must match exactly from https://platform.openai.com/docs/models/ or for Google Gemini use gemini-pro')
661 | parser.add_argument('--health', action='store_true', help='Focus on health and optimization instead of security')
662 | args, remaining_argv = parser.parse_known_args(sys.argv[2:])
663 |
664 | # Remaining arguments and main logic
665 | if mode == 'full':
666 | if len(remaining_argv) < 1:
667 | print("Usage for full scan: latio full ")
668 | sys.exit(1)
669 | directory = remaining_argv[0]
670 | print(full_scan(directory, model=args.model, health=args.health))
671 |
672 | elif mode == 'full-agentic':
673 | if len(remaining_argv) < 1:
674 | print("Usage for full scan: latio full-agentic ")
675 | sys.exit(1)
676 | directory = remaining_argv[0]
677 | try:
678 | result = asyncio.run(full_agent_scan(directory, model=args.model, health=args.health))
679 | print(result)
680 | except Exception as e:
681 | print(f"Error during partial scan: {e}")
682 | import traceback
683 | traceback.print_exc()
684 |
685 | elif mode == 'github':
686 | if len(remaining_argv) < 2:
687 | print("Usage for partial scan: latio partial ")
688 | sys.exit(1)
689 | repo_name = remaining_argv[0]
690 | pr_number = int(remaining_argv[1])
691 | github_token = os.environ.get('GITHUB_TOKEN')
692 | print(github_scan(repo_name, pr_number, github_token, model=args.model, health=args.health))
693 |
694 | elif mode == 'partial-agentic':
695 | if len(remaining_argv) < 1:
696 | print("Usage for full scan: latio partial ")
697 | sys.exit(1)
698 | directory = remaining_argv[0]
699 | # Use asyncio.run to execute the async function
700 | try:
701 | result = asyncio.run(partial_agent_scan(directory, model=args.model, health=args.health))
702 | print(result)
703 | except Exception as e:
704 | print(f"Error during partial scan: {e}")
705 | import traceback
706 | traceback.print_exc()
707 |
708 | elif mode == 'partial':
709 | if len(remaining_argv) < 1:
710 | print("Usage for full scan: latio partial ")
711 | sys.exit(1)
712 | directory = remaining_argv[0]
713 | print(partial_scan(directory, model=args.model, health=args.health))
714 |
715 | elif mode == 'partial-github':
716 | if len(remaining_argv) < 3:
717 | print("Usage for github scan: latio partial-github ")
718 | sys.exit(1)
719 | directory = remaining_argv[0]
720 | base_ref = remaining_argv[1]
721 | head_ref = remaining_argv[2]
722 | print(partial_scan_github(directory, base_ref, head_ref, model=args.model, health=args.health))
723 |
724 | else:
725 | print("Invalid mode. Use 'full' or 'partial'.")
726 | sys.exit(1)
727 |
728 |
729 | if __name__ == "__main__":
730 | main()
--------------------------------------------------------------------------------
/src/latio/workers.py:
--------------------------------------------------------------------------------
1 | from agents import Agent, function_tool, Runner
2 | from agents.extensions.visualization import draw_graph
3 | from agents.extensions import handoff_filters
4 | from agents.extensions.handoff_prompt import RECOMMENDED_PROMPT_PREFIX
5 | import subprocess
6 | import os
7 | from typing import List, Dict, Set
8 |
9 | @function_tool
10 | def analyze_code_context(function_changes: List[str], changed_files: List[str]) -> dict[str, str]:
11 | """
12 | Takes in a list of files and line changes and returns any relevant file details and application context.
13 | """
14 | # Get the file contents
15 | print("Changed files:", changed_files)
16 | file_contents = {}
17 |
18 | # Get the current working directory from the user's bash shell
19 | workspace_root = os.getcwd()
20 |
21 | for file in changed_files:
22 | try:
23 | # Strip out ./ prefix if present
24 | clean_file = file.lstrip('./')
25 | # Construct absolute path for the file
26 | file_path = os.path.join(workspace_root, clean_file)
27 | with open(file_path, 'r') as f:
28 | file_contents[file] = f.read()
29 | except FileNotFoundError:
30 | print(f"Warning: File {file_path} not found")
31 | except Exception as e:
32 | print(f"Warning: Error reading file {file_path}: {str(e)}")
33 |
34 | # Get the codebase info by searching the codebase for any .md files
35 | codebase_info = ""
36 | try:
37 | for root, _, files in os.walk(workspace_root):
38 | for file in files:
39 | if file.endswith(".md"):
40 | file_path = os.path.join(root, file)
41 | try:
42 | with open(file_path, 'r') as f:
43 | codebase_info += f.read() + "\n"
44 | except Exception as e:
45 | print(f"Warning: Error reading markdown file {file_path}: {str(e)}")
46 | except Exception as e:
47 | print(f"Warning: Error walking directory: {str(e)}")
48 |
49 | app_context_agent = Agent(
50 | name="App Context Agent",
51 | ),
52 | context_info_prompt = "You are a developer with a deep understanding of the codebase and the latest best practices. You will receive information about a codebase, changed functions, and file details. Your job is to summarize the application context, including the overall purpose of the application, the overall architecture, and the overall codebase. Here is some information about the codebase and what it's doing: " + str(codebase_info) + "\n Here is the file contents: " + str(file_contents) + "\n Here is the function changes: " + str(function_changes)
53 | app_context = Runner.run(app_context_agent, context_info_prompt)
54 | return app_context
55 |
56 | @function_tool
57 | def gather_full_code(changed_files: List[str]):
58 | """
59 | Takes in a list of files and line changes and returns any relevant file details and application context.
60 | Each line in the returned file contents will be prefixed with its line number.
61 | """
62 | # Get the file contents
63 | print("Analyzing files:", changed_files)
64 | file_contents = {}
65 |
66 | # Get the current working directory
67 | workspace_root = os.getcwd()
68 | print("Workspace root:", workspace_root)
69 |
70 | for file in changed_files:
71 | try:
72 | # Strip out ./ prefix if present
73 | clean_file = file.lstrip('./')
74 | # Construct absolute path for the file
75 | file_path = os.path.join(workspace_root, clean_file)
76 | with open(file_path, 'r') as f:
77 | # Read lines and add line numbers
78 | print(f"Reading file: {file_path}")
79 | lines = f.readlines()
80 | numbered_lines = [f"{i+1}: {line}" for i, line in enumerate(lines)]
81 | file_contents[file] = ''.join(numbered_lines)
82 | except FileNotFoundError:
83 | print(f"Warning: File {file_path} not found")
84 | except Exception as e:
85 | print(f"Warning: Error reading file {file_path}: {str(e)}")
86 |
87 | return file_contents
88 |
89 | security_agent = Agent(
90 | name="Security Agent",
91 | handoff_description="Specialist in evaluating code for security issues.",
92 | instructions=(
93 | """
94 | {RECOMMENDED_PROMPT_PREFIX}
95 | You are a super friendly security expert with a deep understanding of the codebase and the latest security best practices.
96 | You will be given a list of files and code snippets to evaluate for security issues, as well as additional context about the codebase.
97 | Give the user a short summary of the security issues you found, the files they were found in, the lines of code that are affected, and some fix guidance with an example specific to the user's code.
98 | """
99 | ),
100 | )
101 |
102 | health_agent = Agent(
103 | name="Health Agent",
104 | handoff_description="Specialist in evaluating code for health issues.",
105 | instructions=(
106 | "You are a 10x developer with a deep understanding of the codebase and the latest health best practices."
107 | "You will be given a list of files and code snippets to evaluate for health issues, as well as additional context about the codebase ."
108 | "Give the user a short summary of the health issues you found, the files they were found in, the lines of code that are affected, and some fix guidance with an example."
109 | ),
110 | )
111 |
112 | context_agent = Agent(
113 | name="Context Agent",
114 | handoff_description="Specialist in evaluating code for security and health issues.",
115 | instructions=(
116 | "You are a coding expert with a deep understanding of the codebase and the latest security and health best practices."
117 | "You will be given a list of files and lines of code that have been changed in a pull request. You will first find all relevant code and files related to the changes."
118 | "The analyze_code_context function takes in a list of function changes based on the line changes you're seeing, as well as their file paths, and returns a summary of the relevant code and files."
119 | "This will be a lot of information to process, so condense this information for the security and health agents: what the application is generally doing, what the files are doing in the context of the application, and what the function changes are doing in the context of the files."
120 | "Then, based on the relevant code you find, you will hand off to the security agent or the health agent. It is essential that the original code changes are always passed to the security or health agent."
121 | "If there are potential security issues to investigate, handoff to the security agent."
122 | "If there are potential health issues to investigate, handoff to the health agent."
123 | "If there are no issues, return a message to the user that the pull request is good to go."
124 | "ALWAYS HANDOFF TO THE SECURITY OR HEALTH AGENT WITH THE MOST RELEVANT CODE."
125 | ),
126 | handoffs=[security_agent, health_agent],
127 | tools=[analyze_code_context],
128 | )
129 |
130 | full_context_agent_code = Agent(
131 | name="Full Context Agent Code Gatherer",
132 | handoff_description="Specialist in evaluating code for security and health issues.",
133 | instructions=("""
134 | {RECOMMENDED_PROMPT_PREFIX}
135 | You are a coding expert with a deep understanding of the codebase and the latest security and health best practices."
136 | You will be given a list of files for analysis. You will first fetch all of the code for these files using the analyze_code_context function."
137 | This will be a lot of information to process, so condense this information for the security and health agents: what the application is generally doing, what the files are doing in the context of the application, and the specific lines of code that are most relevant for analysis."
138 | If there are potential security issues to investigate, handoff to the security agent with the most relevant code."
139 | If there are potential health issues to investigate, handoff to the health agent with the most relevant code."
140 | ALWAYS HANDOFF TO THE SECURITY OR HEALTH AGENT WITH THE MOST RELEVANT CODE.
141 | """
142 | ),
143 | handoffs=[security_agent, health_agent],
144 | tools=[gather_full_code],
145 | )
146 |
147 | full_context_file_parser = Agent(
148 | name="Full Context Agent File Parser",
149 | handoff_description="Specialist in evaluating code for security and health issues.",
150 | instructions=("""
151 | {RECOMMENDED_PROMPT_PREFIX}
152 | You are a coding expert with a deep understanding of the codebase and the latest security and health best practices.
153 | You are going to receive a list of files with number of characters, return only the ones that seem the most relevant for security or health analysis.
154 | Then, you will make sure to drop any files that seem they will be larger than your context window, which is about 512,000 characters.
155 | Always handoff the relevant files to the full context agent code gatherer to analyze the code.
156 | """
157 | ),
158 | handoffs=[full_context_agent_code],
159 | )
--------------------------------------------------------------------------------