Download the PHP package aws/aws-php-sns-message-validator without Composer
On this page you can find all versions of the php package aws/aws-php-sns-message-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package aws-php-sns-message-validator
Amazon SNS Message Validator for PHP
The Amazon SNS Message Validator for PHP library allows you to validate that incoming HTTP(S) POST messages are valid Amazon SNS notifications. This library is standalone and does not depend on the AWS SDK for PHP or Guzzle; however, it does require PHP 8.1+ and that the OpenSSL PHP extension is installed.
Jump To:
- Basic Usage
- Installation
- About Amazon SNS
- Handling Messages
- Testing Locally
- Contributing
Basic Usage
To validate a message, you can instantiate a Message object from the POST
data using the Message::fromRawPostData. This reads the raw POST data from
the php://input stream, decodes the JSON data, and validates
the message's type and structure.
Next, you must create an instance of MessageValidator, and then use either
the isValid() or validate(), methods to validate the message. The
message validator checks the SigningCertURL, SignatureVersion, and
Signature to make sure they are valid and consistent with the message data.
Installation
The SNS Message Validator can be installed via Composer.
composer require aws/aws-php-sns-message-validatorGetting Help
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Ask a question on StackOverflow and tag it with
aws-php-sdk - Come join the AWS SDK for PHP gitter
- Open a support ticket with AWS Support
- If it turns out that you may have found a bug, please open an issue
About Amazon SNS
Amazon Simple Notification Service (Amazon SNS) is a fast, fully-managed, push messaging service. Amazon SNS can deliver messages to email, mobile devices (i.e., SMS; iOS, Android and FireOS push notifications), Amazon SQS queues,and — of course — HTTP/HTTPS endpoints.
With Amazon SNS, you can setup topics to publish custom messages to subscribed endpoints. However, SNS messages are used by many of the other AWS services to communicate information asynchronously about your AWS resources. Some examples include:
- Configuring Amazon Glacier to notify you when a retrieval job is complete.
- Configuring AWS CloudTrail to notify you when a new log file has been written.
- Configuring Amazon Elastic Transcoder to notify you when a transcoding job changes status (e.g., from "Progressing" to "Complete")
Though you can certainly subscribe your email address to receive SNS messages from service events like these, your inbox would fill up rather quickly. There is great power, however, in being able to subscribe an HTTP/HTTPS endpoint to receive the messages. This allows you to program webhooks for your applications to easily respond to various events.
Handling Messages
Confirming a Subscription to a Topic
In order to handle a SubscriptionConfirmation message, you must use the
SubscribeURL value in the incoming message:
Receiving a Notification
To receive a notification, use the same code as the preceding example, but
check for the Notification message type.
The message body will be a string, and will hold whatever data was published to the SNS topic.
Unsubscribing
Unsubscribing looks the same as subscribing, except the message type will be
UnsubscribeConfirmation.
Testing Locally
One challenge of using webhooks in a web application is testing the integration with the service. Testing integrations with SNS notifications can be fairly easy using tools like ngrok and PHP's built-in webserver. One of our blog posts, Testing Webhooks Locally for Amazon SNS, illustrates a good technique for testing.
NOTE: The code samples in the blog post are specific to the message validator in Version 2 of the SDK, but can be easily adapted to using this version.
Special Thank You
A special thanks goes out to Julian Vidal who helped create the [initial implementation][] in Version 2 of the AWS SDK for PHP.
Contributing
We work hard to provide a high-quality and useful SDK for our AWS services, and we greatly value feedback and contributions from our community. Please review our contributing guidelines before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
