AWS S3 Authentication and Fuzzing for Ceph RGW #962

Suyashd999 · 2025-03-15T19:33:42Z

Summary

This pull request adds support for AWS Signature Version 4 (SigV4) authentication in RESTler, enabling fuzzing of AWS S3-compatible endpoints that require AWS request signing.

Details

Introduced a sample authentication module aws_sigv4_auth.py (originally located in restler/utils) to demonstrate how RESTler can sign requests using AWS S3 credentials (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY), leveraging boto3 and botocore.
After review feedback, the sample file has been removed from restler/utils to avoid including service-specific logic in the RESTler core codebase.
The full sample, with usage and dependency details, is now tracked in a separate GitHub issue for discoverability and ongoing maintenance.

Usage

To enable request signing for AWS S3 or other SigV4-compatible endpoints, follow the aws_sigv4_auth.py example in Issue #987.
Install dependencies: pip install boto3 botocore
Put your AWS credentials in the appropriate environment variables or pass them to the script.
Integrate the sample into your test deployment or adapt as needed for your authentication flow.

+                auth_module = Settings().authentication['module']
+                signing_function = auth_module.get('function', 'sign_request')
+                signing_module = __import__(auth_module['name'], fromlist=[signing_function])
+                sign_request = getattr(signing_module, signing_function)


Could you please use the helper import_attr in import_utilities.py?

marina-p · 2025-10-13T18:30:34Z

restler/utils/aws_sigv4_auth.py

+import boto3
+from botocore.auth import SigV4Auth
+from botocore.awsrequest import AWSRequest
+from botocore.credentials import Credentials


This module needs to be part of your own team's deployment - RESTler does not maintain authentication for specific services in the code base.

maybe this could be added under an "examples" directory, to give users an idea of how to configure a signer?

Ideally such samples would be working samples with their own set of dependencies that could be installed, tested etc. Since we don't have such samples today, could you please open an issue and attach this there to track adding such examples, but keep it separate from this PR so as not to block the PR?

marina-p

🕐

marina-p · 2025-10-13T18:40:20Z

restler/engine/transport_layer/messaging.py


+        # Add request signing if enabled in authentication settings    
+        if Settings().authentication and Settings().authentication.get('module', {}).get('signing'):
+            try:                


Sorry to be catching this at PR time - could you please make this consistent with the other authentication dictionary structure, so "authentication": { "signing": {"module": {"file"/"function"/...}}}. See SettingsFile.md for the structure. #Resolved

marina-p · 2025-10-13T19:08:35Z

restler/engine/transport_layer/messaging.py

                message = _append_to_header(message, f"x-restler-sequence-id: {sequence_id}")

+        # Add request signing if enabled in authentication settings    
+        if Settings().authentication and Settings().authentication.get('module', {}).get('signing'):


signing

Please update the docs - Authentication.md (quick 1-2 sentences description is sufficient), and SettingsFile.md (sample settings object that works when copied into the engine settings with updated paths). #Resolved

marina-p · 2025-10-13T19:15:57Z

Ideally, some tests should be added for this using the unit test server. This can be done in a future PR if you've already validated these changes - could you please open an issue to track this?

In reply to: 3395031310

yuvalif · 2025-10-15T10:01:14Z

Ideally, some tests should be added for this using the unit test server. This can be done in a future PR if you've already validated these changes - could you please open an issue to track this?

In reply to: 3395031310

this configuration and signing mechanism is tested against our server.

if we want to add a dedicated test to restler we probably dont want to test against a full S3 gateway.
several options:

just implement somnething simple: e.g. hash the header and add the hash as a filed on the client, the server will look for the hash field and verify it is correct
use the IETF standard for HTTP signing. there is a pyhon library that already implements that: https://pypi.org/project/http-message-signatures/ . note that it has the verifier code built into the lib
implement a dummy S3 python server that just verify the signature

Suyashd999 · 2025-10-15T21:09:45Z

hey @marina-p, can you review the PR once again. Thanks!

marina-p · 2025-10-23T23:11:29Z

Done - just one remaining comment RE: restler/utls, everything else looks good!

In reply to: 3408292266

Suyashd999 · 2025-10-26T10:04:49Z

Done - just one remaining comment RE: restler/utls, everything else looks good!

In reply to: 3408292266

Hi @marina-p! I have made that change as well. Please do check once ! Thankyou !!

Suyashd999 · 2025-11-01T09:29:01Z

Hi @marina-p! I have made that change as well. Please do check once ! Thankyou !!

Hey @marina-p, a reminder here. Thankyou!

marina-p

yuvalif · 2025-12-09T17:14:32Z

@marina-p anything else that needs to be done so before this is merged?

marina-p · 2025-12-17T01:44:27Z

Hi @yuvalif, the code looks good. The contributor license agreement check needs to pass for it to be merged. @Suyashd999, is it possible for you to sign per the required steps?

marina-p · 2025-12-17T01:45:30Z

See the 'Contributing' section in the README for instructions.

Suyashd999 · 2025-12-17T20:11:21Z

@microsoft-github-policy-service agree

…iguration structure - Import and use import_attr helper from utils.import_utilities for cleaner module loading - Update AWS SigV4 authentication module comments to reflect new config structure - Document request signing authentication in Authentication.md and SettingsFile.md

Suyashd999 marked this pull request as ready for review May 26, 2025 09:11

yuvalif reviewed May 29, 2025

View reviewed changes

restler/utils/aws_sigv4_auth.py Outdated Show resolved Hide resolved

yuvalif reviewed May 29, 2025

View reviewed changes

restler/utils/aws_sigv4_auth.py Outdated Show resolved Hide resolved

yuvalif reviewed May 29, 2025

View reviewed changes

restler/engine/transport_layer/messaging.py Outdated Show resolved Hide resolved

yuvalif mentioned this pull request May 29, 2025

Added support for AWS S3 credentials to do AWS S3 fuzzing #957

Closed

pritha-srivastava mentioned this pull request May 30, 2025

test/rgw: use restler fuzzing tool ceph/ceph#63566

Open

14 tasks

Suyashd999 force-pushed the s3auth branch from 21df061 to 5b81cf8 Compare July 31, 2025 17:20

Suyashd999 changed the title ~~Current configuration for testing RGW with Restler~~ AWS S3 Authentication and Fuzzing for Ceph RGW Aug 1, 2025

Suyashd999 closed this Oct 12, 2025

Suyashd999 reopened this Oct 12, 2025

Suyashd999 mentioned this pull request Oct 12, 2025

AWS S3 Authentication and Fuzzing for Ceph RGW #984

Closed

marina-p reviewed Oct 13, 2025

View reviewed changes

marina-p requested changes Oct 13, 2025

View reviewed changes

marina-p reviewed Oct 13, 2025

View reviewed changes

Suyashd999 requested a review from marina-p October 15, 2025 21:09

Suyashd999 force-pushed the s3auth branch from 8efdd95 to 291a24e Compare October 26, 2025 09:53

Suyashd999 mentioned this pull request Oct 26, 2025

AWS SigV4 Authentication Example for RESTler #987

Open

marina-p approved these changes Dec 4, 2025

View reviewed changes

Suyashd999 added 2 commits December 19, 2025 12:02

Current configuration for testing RGW with Restler

d8207a9

marina-p force-pushed the s3auth branch from 291a24e to 553abc7 Compare December 19, 2025 20:03

AWS S3 Authentication and Fuzzing for Ceph RGW #962

Are you sure you want to change the base?

AWS S3 Authentication and Fuzzing for Ceph RGW #962

Uh oh!

Conversation

Suyashd999 commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

Usage

Related

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yuvalif commented May 29, 2025

Uh oh!

yuvalif commented Aug 25, 2025

Uh oh!

marina-p Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

marina-p Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

yuvalif Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

marina-p Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

marina-p left a comment

Choose a reason for hiding this comment

Uh oh!

marina-p Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marina-p Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marina-p commented Oct 13, 2025

Uh oh!

yuvalif commented Oct 15, 2025

Uh oh!

Suyashd999 commented Oct 15, 2025

Uh oh!

marina-p commented Oct 23, 2025

Uh oh!

Suyashd999 commented Oct 26, 2025

Uh oh!

Suyashd999 commented Nov 1, 2025

Uh oh!

marina-p left a comment

Choose a reason for hiding this comment

Uh oh!

yuvalif commented Dec 9, 2025

Uh oh!

marina-p commented Dec 17, 2025

Uh oh!

marina-p commented Dec 17, 2025

Uh oh!

Suyashd999 commented Dec 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Suyashd999 commented Mar 15, 2025 •

edited

Loading

marina-p Oct 13, 2025 •

edited

Loading

marina-p Oct 13, 2025 •

edited

Loading