PyRIT icon indicating copy to clipboard operation
PyRIT copied to clipboard

FEAT new target class for AWS Bedrock Anthropic Claude models

Open kmarsh77 opened this issue 10 months ago • 13 comments

Description

Adding a new target class for AWS Bedrock Anthropic Claude models. It will only work for Anthropic Claude models as the request body is specific to those, but it should be easy to modify the class for use with other Bedrock models.

boto3 Python library is used for sending requests. Local AWS credentials are used for authentication, typically stored in ~/.aws.

Tests and Documentation

Description of target class and parameters is provided in the class file, aws_bedrock_claude_target.py. Unit tests are provided in tests/unit/test_aws_bedrock_claude_target.py.

kmarsh77 avatar Feb 07 '25 18:02 kmarsh77

@microsoft-github-policy-service agree company="Kroll"

From: microsoft-github-policy-service[bot] @.> Date: Friday, February 7, 2025 at 1:56 PM To: Azure/PyRIT @.> Cc: Marsh, Kassidy @.>, Mention @.> Subject: [EXTERNAL] Re: [Azure/PyRIT] FEAT new target class for AWS Bedrock Anthropic Claude models (PR #699)

@kmarsh77https://github.com/kmarsh77 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft" Contributor License Agreement Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
  3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

— Reply to this email directly, view it on GitHubhttps://github.com/Azure/PyRIT/pull/699#issuecomment-2643736099, or unsubscribehttps://github.com/notifications/unsubscribe-auth/BKN2DPFMU5OBX6VYG2YTZLL2OT6U3AVCNFSM6AAAAABWWS7TL2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNBTG4ZTMMBZHE. You are receiving this because you were mentioned.Message ID: @.***>

This email is confidential and subject to important disclaimers and conditions, including those regarding confidentiality, legal privilege and certain legal entity disclaimers, available at https://www.kroll.com/disclosure. Our Privacy Policy is available at https://www.kroll.com/en/privacy-policy.

kmarsh77 avatar Feb 07 '25 19:02 kmarsh77

I ran pre-commit run --all-files locally and pushed those changes to my fork.

The only error I couldn't fix is the following: pyrit/prompt_target/aws_bedrock_claude_chat_target.py:150: error: Dict entry 1 has incompatible type "str": "dict[str, str]"; expected "str": "str" [dict-item]

This is referring to case where an image is sent in a message; the expected format for AWS Bedrock Claude is: { "type": "image", "source": { "type": "base64", "media_type": "image/jpeg", "data": "content image bytes" } }

Therefore I'm not sure how to fix this error.

kmarsh77 avatar Feb 21 '25 16:02 kmarsh77

I'm seeing odd test errors related to the boto3 import. Stared at it for 10 minutes and can't quite make sense of it. Probably easier to repro if you have the branch locally. Lmk if you are having trouble.

romanlutz avatar Mar 17 '25 06:03 romanlutz

Related: lots of cloud providers like Azure, Google, and other local model providers like ollama use openai compatible APIs so we don't need anything custom. Looks like AWS is a bit behind on that front. I only see workarounds where people have deployed additional things to make that conversion work. Whenever they do become compatible I'd love to just move over to OpenAIChatTarget, though.

romanlutz avatar Mar 17 '25 06:03 romanlutz

@romanlutz I am actually unable to replicate the import error relating to boto3, could you please share the command you are using?

kmarsh77 avatar Mar 20 '25 15:03 kmarsh77

@romanlutz alright I fixed the one error which was invalid value for converted_value_data_type in test_validate_request_invalid_data_type().

The other error is being caused by test_send_prompt_async() and test_complete_chat_async() not seeing an import for boto3 in the target class file (because the import is within try/except block in the initialization function rather than at the top of the file).

I'm not sure how to get around this but will think on it. Let me know if you have any ideas.

kmarsh77 avatar Mar 24 '25 16:03 kmarsh77

@romanlutz alright I fixed the one error which was invalid value for converted_value_data_type in test_validate_request_invalid_data_type().

The other error is being caused by test_send_prompt_async() and test_complete_chat_async() not seeing an import for boto3 in the target class file (because the import is within try/except block in the initialization function rather than at the top of the file).

I'm not sure how to get around this but will think on it. Let me know if you have any ideas.

I'll try to repro it sometime this week. Thank you!

romanlutz avatar Mar 24 '25 17:03 romanlutz

@romanlutz finally had some time to look at this; I think I found the solution in add_image_to_video_converter.py. I just moved the boto3 import to within the complete_chat_async method; this also allowed me to remove the "if TYPE_CHECKING" statement from the top of the file. Let me know if it looks okay to you.

kmarsh77 avatar Apr 16 '25 15:04 kmarsh77

@romanlutz finally had some time to look at this; I think I found the solution in add_image_to_video_converter.py. I just moved the boto3 import to within the complete_chat_async method; this also allowed me to remove the "if TYPE_CHECKING" statement from the top of the file. Let me know if it looks okay to you.

Great timing! I was going to try this out anyway. Will report back by EOW

romanlutz avatar Apr 16 '25 20:04 romanlutz

Sadly, still stuck on AWS sign-up because I'm not going to give them my phone number (nothing to do with AWS, but it's a company account so it shouldn't be associated with my number). Will update when that is resolved.

romanlutz avatar Apr 17 '25 12:04 romanlutz

@kmarsh77 FYI I've started looking into this. Got an account now. The main problem for me right now is that it's not working with key-based auth (in addition to identity-based auth) yet so that's preventing us from adding integration tests. I'm working on updating it that way. It may take a little bit of time since I'm doing that on the side. Thanks for your patience.

romanlutz avatar Jun 09 '25 18:06 romanlutz

@romanlutz hey just checking in on this. Can you please clarify what you mean by "not working with key-based auth"? I might be able to help.

kmarsh77 avatar Aug 27 '25 14:08 kmarsh77

I assumed I'd be able to use an API key which I now understand is wrong. I have yet to try out the identity-based version you implemented. It took us a while to get approval for an AWS subscription. Apologies for the delay.

romanlutz avatar Sep 11 '25 04:09 romanlutz