settings.
531 | *
532 | * @return $this A reference to the current instance.
533 | */
534 | public function disable_ssl_verification($ssl_verification = false)
535 | {
536 | trigger_error('Disabling the verification of SSL certificates can lead to man-in-the-middle attacks. It is potentially unsafe and highly discouraged.', E_USER_WARNING);
537 | $this->ssl_verification = $ssl_verification;
538 | return $this;
539 | }
540 |
541 | /**
542 | * Enables HTTP request/response header logging to `STDERR`.
543 | *
544 | * @param boolean $enabled (Optional) Whether or not to enable debug mode. Defaults to `true`.
545 | * @return $this A reference to the current instance.
546 | */
547 | public function enable_debug_mode($enabled = true)
548 | {
549 | $this->debug_mode = $enabled;
550 | return $this;
551 | }
552 |
553 | /**
554 | * Sets the maximum number of times to retry failed requests.
555 | *
556 | * @param integer $retries (Optional) The maximum number of times to retry failed requests. Defaults to `3`.
557 | * @return $this A reference to the current instance.
558 | */
559 | public function set_max_retries($retries = 3)
560 | {
561 | $this->max_retries = $retries;
562 | return $this;
563 | }
564 |
565 | /**
566 | * Set the caching configuration to use for response caching.
567 | *
568 | * @param string $location (Required) The location to store the cache object in. This may vary by cache method.
- File - The local file system paths such as
./cache (relative) or /tmp/cache/ (absolute). The location must be server-writable. - APC - Pass in
apc to use this lightweight cache. You must have the APC extension installed. - XCache - Pass in
xcache to use this lightweight cache. You must have the XCache extension installed. - Memcached - Pass in an indexed array of associative arrays. Each associative array should have a
host and a port value representing a Memcached server to connect to. - PDO - A URL-style string (e.g.
pdo.mysql://user:pass@localhost/cache) or a standard DSN-style string (e.g. pdo.sqlite:/sqlite/cache.db). MUST be prefixed with pdo.. See CachePDO and PDO for more details.
569 | * @param boolean $gzip (Optional) Whether or not data should be gzipped before being stored. A value of `true` will compress the contents before caching them. A value of `false` will leave the contents uncompressed. Defaults to `true`.
570 | * @return $this A reference to the current instance.
571 | */
572 | public function set_cache_config($location, $gzip = true)
573 | {
574 | // If location is empty, don't do anything.
575 | if (empty($location))
576 | {
577 | return $this;
578 | }
579 |
580 | // If we have an array, we're probably passing in Memcached servers and ports.
581 | if (is_array($location))
582 | {
583 | $this->cache_class = 'CacheMC';
584 | }
585 | else
586 | {
587 | // I would expect locations like `/tmp/cache`, `pdo.mysql://user:pass@hostname:port`, `pdo.sqlite:memory:`, and `apc`.
588 | $type = strtolower(substr($location, 0, 3));
589 | switch ($type)
590 | {
591 | case 'apc':
592 | $this->cache_class = 'CacheAPC';
593 | break;
594 |
595 | case 'xca': // First three letters of `xcache`
596 | $this->cache_class = 'CacheXCache';
597 | break;
598 |
599 | case 'pdo':
600 | $this->cache_class = 'CachePDO';
601 | $location = substr($location, 4);
602 | break;
603 |
604 | default:
605 | $this->cache_class = 'CacheFile';
606 | break;
607 | }
608 | }
609 |
610 | // Set the remaining cache information.
611 | $this->cache_location = $location;
612 | $this->cache_compress = $gzip;
613 |
614 | return $this;
615 | }
616 |
617 | /**
618 | * Register a callback function to execute whenever a data stream is read from using
619 | * .
620 | *
621 | * The user-defined callback function should accept three arguments:
622 | *
623 | *
624 | * $curl_handle - resource - Required - The cURL handle resource that represents the in-progress transfer.$file_handle - resource - Required - The file handle resource that represents the file on the local file system.$length - integer - Required - The length in kilobytes of the data chunk that was transferred.
628 | *
629 | * @param string|array|function $callback (Required) The callback function is called by , so you can pass the following values:
630 | * - The name of a global function to execute, passed as a string.
631 | * - A method to execute, passed as
array('ClassName', 'MethodName').
632 | * - An anonymous function (PHP 5.3+).
633 | * @return $this A reference to the current instance.
634 | */
635 | public function register_streaming_read_callback($callback)
636 | {
637 | $this->registered_streaming_read_callback = $callback;
638 | return $this;
639 | }
640 |
641 | /**
642 | * Register a callback function to execute whenever a data stream is written to using
643 | * .
644 | *
645 | * The user-defined callback function should accept two arguments:
646 | *
647 | *
648 | * $curl_handle - resource - Required - The cURL handle resource that represents the in-progress transfer.$length - integer - Required - The length in kilobytes of the data chunk that was transferred.
651 | *
652 | * @param string|array|function $callback (Required) The callback function is called by , so you can pass the following values:
653 | * - The name of a global function to execute, passed as a string.
654 | * - A method to execute, passed as
array('ClassName', 'MethodName').
655 | * - An anonymous function (PHP 5.3+).
656 | * @return $this A reference to the current instance.
657 | */
658 | public function register_streaming_write_callback($callback)
659 | {
660 | $this->registered_streaming_write_callback = $callback;
661 | return $this;
662 | }
663 |
664 | /**
665 | * Fetches and caches STS credentials. This is meant to be used by the constructor, and is not to be
666 | * manually invoked.
667 | *
668 | * @param CacheCore $cache (Required) The a reference to the cache object that is being used to handle the caching.
669 | * @param array $options (Required) The options that were passed into the constructor.
670 | * @return mixed The data to be cached, or NULL.
671 | */
672 | public function cache_sts_credentials($cache, $options)
673 | {
674 | $token = new AmazonSTS($options);
675 | $response = $token->get_session_token();
676 |
677 | if ($response->isOK())
678 | {
679 | // Update the expiration
680 | $expiration_time = strtotime((string) $response->body->GetSessionTokenResult->Credentials->Expiration);
681 | $expiration_duration = round(($expiration_time - time()) * 0.85);
682 | $cache->expire_in($expiration_duration);
683 |
684 | // Return the important data
685 | $credentials = $response->body->GetSessionTokenResult->Credentials;
686 |
687 | return array(
688 | 'key' => (string) $credentials->AccessKeyId,
689 | 'secret' => (string) $credentials->SecretAccessKey,
690 | 'token' => (string) $credentials->SessionToken,
691 | 'expires' => (string) $credentials->Expiration,
692 | );
693 | }
694 |
695 | // @codeCoverageIgnoreStart
696 | throw new STS_Exception('Temporary credentials from the AWS Security '
697 | . 'Token Service could not be retrieved using the provided long '
698 | . 'term credentials. It\'s possible that the provided long term '
699 | . 'credentials were invalid.');
700 | // @codeCoverageIgnoreEnd
701 | }
702 |
703 | /**
704 | * Fetches and caches EC2 instance profile credentials. This is meant to be used by the constructor, and is not to
705 | * be manually invoked.
706 | *
707 | * @param CacheCore $cache (Required) The a reference to the cache object that is being used to handle the caching.
708 | * @param array $options (Required) The options that were passed into the constructor.
709 | * @return mixed The data to be cached, or NULL.
710 | */
711 | public function cache_instance_profile_credentials($cache, $options)
712 | {
713 | $instance_profile_url = 'http://169.254.169.254/latest/meta-data/iam/security-credentials/';
714 | $connect_timeout = isset($options['instance_profile_timeout']) ? $options['instance_profile_timeout'] : 2;
715 |
716 | try
717 | {
718 | // Make a call to the EC2 Metadata Service to find the available instance profile
719 | $request = new RequestCore($instance_profile_url);
720 | $request->set_curlopts(array(CURLOPT_CONNECTTIMEOUT => $connect_timeout));
721 | $response = $request->send_request(true);
722 |
723 | if ($response->isOK())
724 | {
725 | // Get the instance profile name
726 | $profile = (string) $response->body;
727 |
728 | // Make a call to the EC2 Metadata Service to get the instance profile credentials
729 | $request = new RequestCore($instance_profile_url . $profile);
730 | $request->set_curlopts(array(CURLOPT_CONNECTTIMEOUT => $connect_timeout));
731 | $response = $request->send_request(true);
732 |
733 | if ($response->isOK())
734 | {
735 | // Get the credentials
736 | $credentials = json_decode($response->body, true);
737 |
738 | if ($credentials['Code'] === 'Success')
739 | {
740 | // Determine the expiration time
741 | $expiration_time = strtotime((string) $credentials['Expiration']);
742 | $expiration_duration = round(($expiration_time - time()) * 0.85);
743 | $cache->expire_in($expiration_duration);
744 |
745 | // Return the credential information
746 | return array(
747 | 'key' => $credentials['AccessKeyId'],
748 | 'secret' => $credentials['SecretAccessKey'],
749 | 'token' => $credentials['Token'],
750 | 'expires' => $credentials['Expiration'],
751 | );
752 | }
753 | }
754 | }
755 | }
756 | catch (cURL_Exception $e)
757 | {
758 | // The EC2 Metadata Service does not exist or had timed out.
759 | // An exception will be thrown on the next line.
760 | }
761 |
762 | // @codeCoverageIgnoreStart
763 | throw new CFCredentials_Exception('No credentials were provided. The SDK attempted to retrieve Instance '
764 | . 'Profile credentials from the EC2 Instance Metadata Service, but failed to do so. Instance profile '
765 | . 'credentials are only accessible on EC2 instances configured with a specific IAM role.');
766 | // @codeCoverageIgnoreEnd
767 | }
768 |
769 |
770 | /*%******************************************************************************************%*/
771 | // SET CUSTOM CLASSES
772 |
773 | /**
774 | * Set a custom class for this functionality. Use this method when extending/overriding existing classes
775 | * with new functionality.
776 | *
777 | * The replacement class must extend from .
778 | *
779 | * @param string $class (Optional) The name of the new class to use for this functionality.
780 | * @return $this A reference to the current instance.
781 | */
782 | public function set_utilities_class($class = 'CFUtilities')
783 | {
784 | $this->utilities_class = $class;
785 | $this->util = new $this->utilities_class();
786 | return $this;
787 | }
788 |
789 | /**
790 | * Set a custom class for this functionality. Use this method when extending/overriding existing classes
791 | * with new functionality.
792 | *
793 | * The replacement class must extend from .
794 | *
795 | * @param string $class (Optional) The name of the new class to use for this functionality.
796 | * @param $this A reference to the current instance.
797 | */
798 | public function set_request_class($class = 'CFRequest')
799 | {
800 | $this->request_class = $class;
801 | return $this;
802 | }
803 |
804 | /**
805 | * Set a custom class for this functionality. Use this method when extending/overriding existing classes
806 | * with new functionality.
807 | *
808 | * The replacement class must extend from .
809 | *
810 | * @param string $class (Optional) The name of the new class to use for this functionality.
811 | * @return $this A reference to the current instance.
812 | */
813 | public function set_response_class($class = 'CFResponse')
814 | {
815 | $this->response_class = $class;
816 | return $this;
817 | }
818 |
819 | /**
820 | * Set a custom class for this functionality. Use this method when extending/overriding existing classes
821 | * with new functionality.
822 | *
823 | * The replacement class must extend from .
824 | *
825 | * @param string $class (Optional) The name of the new class to use for this functionality.
826 | * @return $this A reference to the current instance.
827 | */
828 | public function set_parser_class($class = 'CFSimpleXML')
829 | {
830 | $this->parser_class = $class;
831 | return $this;
832 | }
833 |
834 | /**
835 | * Set a custom class for this functionality. Use this method when extending/overriding existing classes
836 | * with new functionality.
837 | *
838 | * The replacement class must extend from .
839 | *
840 | * @param string $class (Optional) The name of the new class to use for this functionality.
841 | * @return $this A reference to the current instance.
842 | */
843 | public function set_batch_class($class = 'CFBatchRequest')
844 | {
845 | $this->batch_class = $class;
846 | return $this;
847 | }
848 |
849 |
850 | /*%******************************************************************************************%*/
851 | // AUTHENTICATION
852 |
853 | /**
854 | * Default, shared method for authenticating a connection to AWS.
855 | *
856 | * @param string $operation (Required) Indicates the operation to perform.
857 | * @param array $payload (Required) An associative array of parameters for authenticating. See the individual methods for allowed keys.
858 | * @return CFResponse Object containing a parsed HTTP response.
859 | */
860 | public function authenticate($operation, $payload)
861 | {
862 | $original_payload = $payload;
863 | $method_arguments = func_get_args();
864 | $curlopts = array();
865 | $return_curl_handle = false;
866 |
867 | if (substr($operation, 0, strlen($this->operation_prefix)) !== $this->operation_prefix)
868 | {
869 | $operation = $this->operation_prefix . $operation;
870 | }
871 |
872 | // Extract the custom CURLOPT settings from the payload
873 | if (is_array($payload) && isset($payload['curlopts']))
874 | {
875 | $curlopts = $payload['curlopts'];
876 | unset($payload['curlopts']);
877 | }
878 |
879 | // Determine whether the response or curl handle should be returned
880 | if (is_array($payload) && isset($payload['returnCurlHandle']))
881 | {
882 | $return_curl_handle = isset($payload['returnCurlHandle']) ? $payload['returnCurlHandle'] : false;
883 | unset($payload['returnCurlHandle']);
884 | }
885 |
886 | // Use the caching flow to determine if we need to do a round-trip to the server.
887 | if ($this->use_cache_flow)
888 | {
889 | // Generate an identifier specific to this particular set of arguments.
890 | $cache_id = $this->key . '_' . get_class($this) . '_' . $operation . '_' . sha1(serialize($method_arguments));
891 |
892 | // Instantiate the appropriate caching object.
893 | $this->cache_object = new $this->cache_class($cache_id, $this->cache_location, $this->cache_expires, $this->cache_compress);
894 |
895 | if ($this->delete_cache)
896 | {
897 | $this->use_cache_flow = false;
898 | $this->delete_cache = false;
899 | return $this->cache_object->delete();
900 | }
901 |
902 | // Invoke the cache callback function to determine whether to pull data from the cache or make a fresh request.
903 | $data = $this->cache_object->response_manager(array($this, 'cache_callback'), $method_arguments);
904 |
905 | // Parse the XML body
906 | $data = $this->parse_callback($data);
907 |
908 | // End!
909 | return $data;
910 | }
911 |
912 | /*%******************************************************************************************%*/
913 |
914 | // Signer
915 | $signer = new $this->auth_class($this->hostname, $operation, $payload, $this->credentials);
916 | $signer->key = $this->key;
917 | $signer->secret_key = $this->secret_key;
918 | $signer->auth_token = $this->auth_token;
919 | $signer->api_version = $this->api_version;
920 | $signer->utilities_class = $this->utilities_class;
921 | $signer->request_class = $this->request_class;
922 | $signer->response_class = $this->response_class;
923 | $signer->use_ssl = $this->use_ssl;
924 | $signer->proxy = $this->proxy;
925 | $signer->util = $this->util;
926 | $signer->registered_streaming_read_callback = $this->registered_streaming_read_callback;
927 | $signer->registered_streaming_write_callback = $this->registered_streaming_write_callback;
928 | $request = $signer->authenticate();
929 |
930 | // Update RequestCore settings
931 | $request->request_class = $this->request_class;
932 | $request->response_class = $this->response_class;
933 | $request->ssl_verification = $this->ssl_verification;
934 |
935 | /*%******************************************************************************************%*/
936 |
937 | // Debug mode
938 | if ($this->debug_mode)
939 | {
940 | $request->debug_mode = $this->debug_mode;
941 | }
942 |
943 | // Set custom CURLOPT settings
944 | if (count($curlopts))
945 | {
946 | $request->set_curlopts($curlopts);
947 | }
948 |
949 | // Manage the (newer) batch request API or the (older) returnCurlHandle setting.
950 | if ($this->use_batch_flow)
951 | {
952 | $handle = $request->prep_request();
953 | $this->batch_object->add($handle);
954 | $this->use_batch_flow = false;
955 |
956 | return $handle;
957 | }
958 | elseif ($return_curl_handle)
959 | {
960 | return $request->prep_request();
961 | }
962 |
963 | // Send!
964 | $request->send_request();
965 |
966 | // Prepare the response.
967 | $headers = $request->get_response_header();
968 | $headers['x-aws-stringtosign'] = $signer->string_to_sign;
969 |
970 | if (isset($signer->canonical_request))
971 | {
972 | $headers['x-aws-canonicalrequest'] = $signer->canonical_request;
973 | }
974 |
975 | $headers['x-aws-request-headers'] = $request->request_headers;
976 | $headers['x-aws-body'] = $signer->querystring;
977 |
978 | $data = new $this->response_class($headers, ($this->parse_the_response === true) ? $this->parse_callback($request->get_response_body()) : $request->get_response_body(), $request->get_response_code());
979 |
980 | $response_body = (string) $request->get_response_body();
981 |
982 | // Was it Amazon's fault the request failed? Retry the request until we reach $max_retries.
983 | if (
984 | (integer) $request->get_response_code() === 500 || // Internal Error (presumably transient)
985 | (integer) $request->get_response_code() === 503) // Service Unavailable (presumably transient)
986 | {
987 | if ($this->redirects <= $this->max_retries)
988 | {
989 | // Exponential backoff
990 | $delay = (integer) (pow(4, $this->redirects) * 100000);
991 | usleep($delay);
992 | $this->redirects++;
993 | $data = $this->authenticate($operation, $original_payload);
994 | }
995 | }
996 |
997 | // DynamoDB has additional, custom logic for retrying requests
998 | else
999 | {
1000 | // If the request to DynamoDB was throttled, we need to retry
1001 | $need_to_retry_dynamodb_request = (
1002 | (integer) $request->get_response_code() === 400 &&
1003 | stripos($response_body, 'com.amazonaws.dynamodb.') !== false &&
1004 | stripos($response_body, 'ProvisionedThroughputExceededException') !== false
1005 | );
1006 |
1007 | // If the CRC32 of the response does not match the expected value, we need to retry
1008 | $response_headers = $request->get_response_header();
1009 | if (!$need_to_retry_dynamodb_request && isset($response_headers['x-amz-crc32']))
1010 | {
1011 | $crc32_expected = $response_headers['x-amz-crc32'];
1012 | $crc32_actual = hexdec(hash('crc32b', $response_body));
1013 | $need_to_retry_dynamodb_request = ($crc32_expected != $crc32_actual);
1014 | }
1015 |
1016 | // Perform retry if necessary using a more aggressive exponential backoff
1017 | if ($need_to_retry_dynamodb_request)
1018 | {
1019 | if ($this->redirects === 0)
1020 | {
1021 | $this->redirects++;
1022 | $data = $this->authenticate($operation, $original_payload);
1023 | }
1024 | elseif ($this->redirects <= max($this->max_retries, 10))
1025 | {
1026 | // Exponential backoff
1027 | $delay = (integer) (pow(2, ($this->redirects - 1)) * 50000);
1028 | usleep($delay);
1029 | $this->redirects++;
1030 | $data = $this->authenticate($operation, $original_payload);
1031 | }
1032 | }
1033 | }
1034 |
1035 | $this->redirects = 0;
1036 | return $data;
1037 | }
1038 |
1039 |
1040 | /*%******************************************************************************************%*/
1041 | // BATCH REQUEST LAYER
1042 |
1043 | /**
1044 | * Specifies that the intended request should be queued for a later batch request.
1045 | *
1046 | * @param CFBatchRequest $queue (Optional) The instance to use for managing batch requests. If not available, it generates a new instance of .
1047 | * @return $this A reference to the current instance.
1048 | */
1049 | public function batch(CFBatchRequest &$queue = null)
1050 | {
1051 | if ($queue)
1052 | {
1053 | $this->batch_object = $queue;
1054 | }
1055 | elseif ($this->internal_batch_object)
1056 | {
1057 | $this->batch_object = &$this->internal_batch_object;
1058 | }
1059 | else
1060 | {
1061 | $this->internal_batch_object = new $this->batch_class();
1062 | $this->batch_object = &$this->internal_batch_object;
1063 | }
1064 |
1065 | $this->use_batch_flow = true;
1066 |
1067 | return $this;
1068 | }
1069 |
1070 | /**
1071 | * Executes the batch request queue by sending all queued requests.
1072 | *
1073 | * @param boolean $clear_after_send (Optional) Whether or not to clear the batch queue after sending a request. Defaults to `true`. Set this to `false` if you are caching batch responses and want to retrieve results later.
1074 | * @return array An array of objects.
1075 | */
1076 | public function send($clear_after_send = true)
1077 | {
1078 | if ($this->use_batch_flow)
1079 | {
1080 | // When we send the request, disable batch flow.
1081 | $this->use_batch_flow = false;
1082 |
1083 | // If we're not caching, simply send the request.
1084 | if (!$this->use_cache_flow)
1085 | {
1086 | $response = $this->batch_object->send();
1087 | $parsed_data = array_map(array($this, 'parse_callback'), $response);
1088 | $parsed_data = new CFArray($parsed_data);
1089 |
1090 | // Clear the queue
1091 | if ($clear_after_send)
1092 | {
1093 | $this->batch_object->queue = array();
1094 | }
1095 |
1096 | return $parsed_data;
1097 | }
1098 |
1099 | // Generate an identifier specific to this particular set of arguments.
1100 | $cache_id = $this->key . '_' . get_class($this) . '_' . sha1(serialize($this->batch_object));
1101 |
1102 | // Instantiate the appropriate caching object.
1103 | $this->cache_object = new $this->cache_class($cache_id, $this->cache_location, $this->cache_expires, $this->cache_compress);
1104 |
1105 | if ($this->delete_cache)
1106 | {
1107 | $this->use_cache_flow = false;
1108 | $this->delete_cache = false;
1109 | return $this->cache_object->delete();
1110 | }
1111 |
1112 | // Invoke the cache callback function to determine whether to pull data from the cache or make a fresh request.
1113 | $data_set = $this->cache_object->response_manager(array($this, 'cache_callback_batch'), array($this->batch_object));
1114 | $parsed_data = array_map(array($this, 'parse_callback'), $data_set);
1115 | $parsed_data = new CFArray($parsed_data);
1116 |
1117 | // Clear the queue
1118 | if ($clear_after_send)
1119 | {
1120 | $this->batch_object->queue = array();
1121 | }
1122 |
1123 | // End!
1124 | return $parsed_data;
1125 | }
1126 |
1127 | // Load the class
1128 | $null = new CFBatchRequest();
1129 | unset($null);
1130 |
1131 | throw new CFBatchRequest_Exception('You must use $object->batch()->send()');
1132 | }
1133 |
1134 | /**
1135 | * Parses a response body into a PHP object if appropriate.
1136 | *
1137 | * @param CFResponse|string $response (Required) The object to parse, or an XML string that would otherwise be a response body.
1138 | * @param string $content_type (Optional) The content-type to use when determining how to parse the content.
1139 | * @return CFResponse|string A parsed object, or parsed XML.
1140 | */
1141 | public function parse_callback($response, $headers = null)
1142 | {
1143 | // Bail out
1144 | if (!$this->parse_the_response) return $response;
1145 |
1146 | // Shorten this so we have a (mostly) single code path
1147 | if (isset($response->body))
1148 | {
1149 | if (is_string($response->body))
1150 | {
1151 | $body = $response->body;
1152 | }
1153 | else
1154 | {
1155 | return $response;
1156 | }
1157 | }
1158 | elseif (is_string($response))
1159 | {
1160 | $body = $response;
1161 | }
1162 | else
1163 | {
1164 | return $response;
1165 | }
1166 |
1167 | // Decompress gzipped content
1168 | if (isset($headers['content-encoding']))
1169 | {
1170 | switch (strtolower(trim($headers['content-encoding'], "\x09\x0A\x0D\x20")))
1171 | {
1172 | case 'gzip':
1173 | case 'x-gzip':
1174 | $decoder = new CFGzipDecode($body);
1175 | if ($decoder->parse())
1176 | {
1177 | $body = $decoder->data;
1178 | }
1179 | break;
1180 |
1181 | case 'deflate':
1182 | if (($uncompressed = gzuncompress($body)) !== false)
1183 | {
1184 | $body = $uncompressed;
1185 | }
1186 | elseif (($uncompressed = gzinflate($body)) !== false)
1187 | {
1188 | $body = $uncompressed;
1189 | }
1190 | break;
1191 | }
1192 | }
1193 |
1194 | // Look for XML cues
1195 | if (
1196 | (isset($headers['content-type']) && ($headers['content-type'] === 'text/xml' || $headers['content-type'] === 'application/xml')) || // We know it's XML
1197 | (!isset($headers['content-type']) && (stripos($body, '') === 0) || preg_match('/^<(\w*) xmlns="http(s?):\/\/(\w*).amazon(aws)?.com/im', $body)) // Sniff for XML
1198 | )
1199 | {
1200 | // Strip the default XML namespace to simplify XPath expressions
1201 | $body = str_replace("xmlns=", "ns=", $body);
1202 |
1203 | try {
1204 | // Parse the XML body
1205 | $body = new $this->parser_class($body);
1206 | }
1207 | catch (Exception $e)
1208 | {
1209 | throw new Parser_Exception($e->getMessage());
1210 | }
1211 | }
1212 | // Look for JSON cues
1213 | elseif (
1214 | (isset($headers['content-type']) && ($headers['content-type'] === 'application/json') || $headers['content-type'] === 'application/x-amz-json-1.0') || // We know it's JSON
1215 | (!isset($headers['content-type']) && $this->util->is_json($body)) // Sniff for JSON
1216 | )
1217 | {
1218 | // Normalize JSON to a CFSimpleXML object
1219 | $body = CFJSON::to_xml($body, $this->parser_class);
1220 | }
1221 |
1222 | // Put the parsed data back where it goes
1223 | if (isset($response->body))
1224 | {
1225 | $response->body = $body;
1226 | }
1227 | else
1228 | {
1229 | $response = $body;
1230 | }
1231 |
1232 | return $response;
1233 | }
1234 |
1235 |
1236 | /*%******************************************************************************************%*/
1237 | // CACHING LAYER
1238 |
1239 | /**
1240 | * Specifies that the resulting object should be cached according to the settings from
1241 | * .
1242 | *
1243 | * @param string|integer $expires (Required) The time the cache is to expire. Accepts a number of seconds as an integer, or an amount of time, as a string, that is understood by (e.g. "1 hour").
1244 | * @return $this A reference to the current instance.
1245 | */
1246 | public function cache($expires)
1247 | {
1248 | // Die if they haven't used set_cache_config().
1249 | if (!$this->cache_class)
1250 | {
1251 | throw new CFRuntime_Exception('Must call set_cache_config() before using cache()');
1252 | }
1253 |
1254 | if (is_string($expires))
1255 | {
1256 | $expires = strtotime($expires);
1257 | $this->cache_expires = $expires - time();
1258 | }
1259 | elseif (is_int($expires))
1260 | {
1261 | $this->cache_expires = $expires;
1262 | }
1263 |
1264 | $this->use_cache_flow = true;
1265 |
1266 | return $this;
1267 | }
1268 |
1269 | /**
1270 | * The callback function that is executed when the cache doesn't exist or has expired. The response of
1271 | * this method is cached. Accepts identical parameters as the method. Never call this
1272 | * method directly -- it is used internally by the caching system.
1273 | *
1274 | * @param string $operation (Required) Indicates the operation to perform.
1275 | * @param array $payload (Required) An associative array of parameters for authenticating. See the individual methods for allowed keys.
1276 | * @return CFResponse A parsed HTTP response.
1277 | */
1278 | public function cache_callback($operation, $payload)
1279 | {
1280 | // Disable the cache flow since it's already been handled.
1281 | $this->use_cache_flow = false;
1282 |
1283 | // Make the request
1284 | $response = $this->authenticate($operation, $payload);
1285 |
1286 | // If this is an XML document, convert it back to a string.
1287 | if (isset($response->body) && ($response->body instanceof SimpleXMLElement))
1288 | {
1289 | $response->body = $response->body->asXML();
1290 | }
1291 |
1292 | return $response;
1293 | }
1294 |
1295 | /**
1296 | * Used for caching the results of a batch request. Never call this method directly; it is used
1297 | * internally by the caching system.
1298 | *
1299 | * @param CFBatchRequest $batch (Required) The batch request object to send.
1300 | * @return CFResponse A parsed HTTP response.
1301 | */
1302 | public function cache_callback_batch(CFBatchRequest $batch)
1303 | {
1304 | return $batch->send();
1305 | }
1306 |
1307 | /**
1308 | * Deletes a cached object using the specified cache storage type.
1309 | *
1310 | * @return boolean A value of `true` if cached object exists and is successfully deleted, otherwise `false`.
1311 | */
1312 | public function delete_cache()
1313 | {
1314 | $this->use_cache_flow = true;
1315 | $this->delete_cache = true;
1316 |
1317 | return $this;
1318 | }
1319 | }
1320 |
1321 |
1322 | /**
1323 | * Contains the functionality for auto-loading service classes.
1324 | */
1325 | class CFLoader
1326 | {
1327 | /*%******************************************************************************************%*/
1328 | // AUTO-LOADER
1329 |
1330 | /**
1331 | * Automatically load classes that aren't included.
1332 | *
1333 | * @param string $class (Required) The classname to load.
1334 | * @return boolean Whether or not the file was successfully loaded.
1335 | */
1336 | public static function autoloader($class)
1337 | {
1338 | $path = dirname(__FILE__) . DIRECTORY_SEPARATOR;
1339 |
1340 | // Amazon SDK classes
1341 | if (strstr($class, 'Amazon'))
1342 | {
1343 | if (file_exists($require_this = $path . 'services' . DIRECTORY_SEPARATOR . str_ireplace('Amazon', '', strtolower($class)) . '.class.php'))
1344 | {
1345 | require_once $require_this;
1346 | return true;
1347 | }
1348 |
1349 | return false;
1350 | }
1351 |
1352 | // Utility classes
1353 | elseif (strstr($class, 'CF'))
1354 | {
1355 | if (file_exists($require_this = $path . 'utilities' . DIRECTORY_SEPARATOR . str_ireplace('CF', '', strtolower($class)) . '.class.php'))
1356 | {
1357 | require_once $require_this;
1358 | return true;
1359 | }
1360 |
1361 | return false;
1362 | }
1363 |
1364 | // Load CacheCore
1365 | elseif (strstr($class, 'Cache'))
1366 | {
1367 | if (file_exists($require_this = $path . 'lib' . DIRECTORY_SEPARATOR . 'cachecore' . DIRECTORY_SEPARATOR . strtolower($class) . '.class.php'))
1368 | {
1369 | require_once $require_this;
1370 | return true;
1371 | }
1372 |
1373 | return false;
1374 | }
1375 |
1376 | // Load RequestCore
1377 | elseif (strstr($class, 'RequestCore') || strstr($class, 'ResponseCore'))
1378 | {
1379 | if (file_exists($require_this = $path . 'lib' . DIRECTORY_SEPARATOR . 'requestcore' . DIRECTORY_SEPARATOR . 'requestcore.class.php'))
1380 | {
1381 | require_once $require_this;
1382 | return true;
1383 | }
1384 |
1385 | return false;
1386 | }
1387 |
1388 | // Load Transmogrifier
1389 | elseif (strstr($class, 'Transmogrifier'))
1390 | {
1391 | if (file_exists($require_this = $path . 'lib' . DIRECTORY_SEPARATOR . 'dom' . DIRECTORY_SEPARATOR . 'Transmogrifier.php'))
1392 | {
1393 | require_once $require_this;
1394 | return true;
1395 | }
1396 |
1397 | return false;
1398 | }
1399 |
1400 | // Load Authentication Signers
1401 | elseif (strstr($class, 'Auth'))
1402 | {
1403 | if (file_exists($require_this = $path . 'authentication' . DIRECTORY_SEPARATOR . str_replace('auth', 'signature_', strtolower($class)) . '.class.php'))
1404 | {
1405 | require_once $require_this;
1406 | return true;
1407 | }
1408 |
1409 | return false;
1410 | }
1411 |
1412 | // Load Signer interface
1413 | elseif ($class === 'Signer')
1414 | {
1415 | if (!interface_exists('Signable', false) &&
1416 | file_exists($require_this = $path . 'authentication' . DIRECTORY_SEPARATOR . 'signable.interface.php'))
1417 | {
1418 | require_once $require_this;
1419 | }
1420 |
1421 | if (file_exists($require_this = $path . 'authentication' . DIRECTORY_SEPARATOR . 'signer.abstract.php'))
1422 | {
1423 | require_once $require_this;
1424 | return true;
1425 | }
1426 |
1427 | return false;
1428 | }
1429 |
1430 | // Load Symfony YAML classes
1431 | elseif (strstr($class, 'sfYaml'))
1432 | {
1433 | if (file_exists($require_this = $path . 'lib' . DIRECTORY_SEPARATOR . 'yaml' . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'sfYaml.php'))
1434 | {
1435 | require_once $require_this;
1436 | return true;
1437 | }
1438 |
1439 | return false;
1440 | }
1441 |
1442 | return false;
1443 | }
1444 | }
1445 |
1446 | // Register the autoloader.
1447 | spl_autoload_register(array('CFLoader', 'autoloader'));
1448 |
1449 |
1450 | /*%******************************************************************************************%*/
1451 | // CONFIGURATION
1452 |
1453 | // If config auto-discovery is explicitly disabled, stop here
1454 | if (defined('AWS_DISABLE_CONFIG_AUTO_DISCOVERY')) return;
1455 |
1456 | // Look for include file in the same directory (e.g. `./config.inc.php`).
1457 | if (file_exists(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc.php'))
1458 | {
1459 | include_once dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc.php';
1460 | }
1461 | // Fallback to `~/.aws/sdk/config.inc.php`
1462 | else
1463 | {
1464 | if (!isset($_ENV['HOME']) && isset($_SERVER['HOME']))
1465 | {
1466 | $_ENV['HOME'] = $_SERVER['HOME'];
1467 | }
1468 | elseif (!isset($_ENV['HOME']) && !isset($_SERVER['HOME']))
1469 | {
1470 | $os = strtolower(PHP_OS);
1471 | if (in_array($os, array('windows', 'winnt', 'win32')))
1472 | {
1473 | $_ENV['HOME'] = false;
1474 | }
1475 | else
1476 | {
1477 | $dir = exec('(cd ~ && pwd) 2>&1', $out, $exit);
1478 | if ($exit === 0)
1479 | {
1480 | $_ENV['HOME'] = trim($dir);
1481 | }
1482 | else
1483 | {
1484 | error_log('Failed to determine HOME directory after trying "' . $dir . '" (exit code ' . $exit . ')');
1485 | $_ENV['HOME'] = false;
1486 | }
1487 | }
1488 |
1489 | if (!$_ENV['HOME'])
1490 | {
1491 | switch ($os)
1492 | {
1493 | case 'darwin':
1494 | $_ENV['HOME'] = '/Users/' . get_current_user();
1495 | break;
1496 |
1497 | case 'windows':
1498 | case 'winnt':
1499 | case 'win32':
1500 | $_ENV['HOME'] = 'c:' . DIRECTORY_SEPARATOR . 'Documents and Settings' . DIRECTORY_SEPARATOR . get_current_user();
1501 | break;
1502 |
1503 | default:
1504 | $_ENV['HOME'] = '/home/' . get_current_user();
1505 | break;
1506 | }
1507 | }
1508 | }
1509 |
1510 | $path = DIRECTORY_SEPARATOR . '.aws' . DIRECTORY_SEPARATOR . 'sdk' . DIRECTORY_SEPARATOR . 'config.inc.php';
1511 | if (isset($_ENV['HOME']) && file_exists($_ENV['HOME'] . $path))
1512 | {
1513 | include_once $_ENV['HOME'] . $path;
1514 | }
1515 |
1516 | unset($os, $dir, $out, $exit, $path);
1517 | }
1518 |
--------------------------------------------------------------------------------
18 |
19 |
--------------------------------------------------------------------------------
/addon/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "manifest_version": 2,
3 | "name": "Bucky",
4 | "version": "1.0",
5 |
6 |
7 | "description": "Bucky discovers AWS S3 buckets from the web pages and sends it to the backend engine to check for misconfiguration.",
8 |
9 | "icons": {
10 | "48": "bucky.png"
11 | },
12 |
13 | "content_scripts": [
14 | {
15 | "matches": ["*://*/*"],
16 | "js": ["bucky.js"]
17 | }
18 | ],
19 |
20 | "permissions": [
21 | "http://127.0.0.1/*",
22 | "webRequest"
23 | ]
24 | }
25 |
--------------------------------------------------------------------------------
/.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 |
--------------------------------------------------------------------------------
/dbreset.php:
--------------------------------------------------------------------------------
1 | open('bucky.db');
6 | }
7 | }
8 | $db = new MyDB();
9 | if(!$db) {
10 | echo $db->lastErrorMsg();
11 | } else {
12 | $sql =<<