C Signing Guide
Preparing the Environment
This section uses Linux Ubuntu as an example. Before calling APIs, install the required SSL tools.
- Install the OpenSSL library.
1apt-get install libssl-dev
- Install the curl library.
1apt-get install libcurl4-openssl-dev
Obtaining the SDK
Log in to the APIG console and choose Help Center > SDK Process Flow. Then download the SDK.
Decompress the downloaded package to the current folder. The following table shows the directory structure.
|
Name |
Description |
|---|---|
|
signer_common.c |
SDK code |
|
signer_common.h |
|
|
signer.c |
|
|
signer.h |
|
|
Makefile |
Makefile file |
|
main.c |
Sample code |
Request Signing and API Calling
After the calling information is modified, the sample code can be directly called. For details about the calling information, see Preparations.
- Add the following references to main.c:
1 2 3 4 5
#include <stdio.h> #include <stdlib.h> #include <string.h> #include <curl/curl.h> #include "signer.h"
- Generate a sig_params_t variable, and enter the AK and SK.
- In this example, the AK and SK stored in the environment variables are used. Specify the environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment first. The following uses Linux as an example to describe how to set the obtained AK/SK as environment variables.
- Open the terminal and run the following command to open the environment variable configuration file:
- Set environment variables, save the file, and exit the editor.
export CLOUD_SDK_AK="Obtained AK" export CLOUD_SDK_SK="Obtained SK"
- Run the following command to apply the modification:
- Generate a sig_params_t variable, and enter the configured environment variables.
1 2 3 4 5 6
sig_params_t params; sig_params_init(¶ms); sig_str_t ak = sig_str(getenv("CLOUD_SDK_AK")); sig_str_t sk = sig_str(getenv("CLOUD_SDK_SK")); params.key = ak; params.secret = sk;
- In this example, the AK and SK stored in the environment variables are used. Specify the environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment first. The following uses Linux as an example to describe how to set the obtained AK/SK as environment variables.
- Specify the method, domain name, request URI, query strings, and request body.
1 2 3 4 5 6 7 8 9 10
sig_str_t host = sig_str("service.region.example.com"); sig_str_t method = sig_str("GET"); sig_str_t uri = sig_str("/v1/{project_id}/vpcs"); sig_str_t query_str = sig_str("limit=2"); sig_str_t payload = sig_str(""); params.host = host; params.method = method; params.uri = uri; params.query_str = query_str; params.payload = payload;
- Add header parameters or other headers required for other purposes. For example, add the X-Project-Id header in multi-project scenarios or the X-Domain-Id header for a global service.
1 2
//Add header parameters, for example, X-Domain-Id for invoking a global service and X-Project-Id for invoking a project-level service. sig_headers_add(¶ms.headers, "X-Project-Id", "xxx");
- Execute the following function to add the generated headers as request variables.
1sig_sign(¶ms);
- Use the curl library to access the API and view the access result.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
static size_t WriteMemoryCallback(void *contents, size_t size, size_t nmemb, void *userp) { size_t realsize = size * nmemb; struct MemoryStruct *mem = (struct MemoryStruct *)userp; mem->memory = (char*)realloc(mem->memory, mem->size + realsize + 1); if (mem->memory == NULL) { /* out of memory! */ printf("not enough memory (realloc returned NULL)\n"); return 0; } memcpy(&(mem->memory[mem->size]), contents, realsize); mem->size += realsize; mem->memory[mem->size] = 0; return realsize; } //send http request using curl library int perform_request(RequestParams* request) { CURL *curl; CURLcode res; struct MemoryStruct resp_header; resp_header.memory = malloc(1); resp_header.size = 0; struct MemoryStruct resp_body; resp_body.memory = malloc(1); resp_body.size = 0; curl_global_init(CURL_GLOBAL_ALL); curl = curl_easy_init(); curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, params.method.data); char url[1024]; sig_snprintf(url, 1024, "http://%V%V?%V", ¶ms.host, ¶ms.uri, ¶ms.query_str); curl_easy_setopt(curl, CURLOPT_URL, url); struct curl_slist *chunk = NULL; for (int i = 0; i < params.headers.len; i++) { char header[1024]; sig_snprintf(header, 1024, "%V: %V", ¶ms.headers.data[i].name, ¶ms.headers.data[i].value); printf("%s\n", header); chunk = curl_slist_append(chunk, header); } printf("-------------\n"); curl_easy_setopt(curl, CURLOPT_HTTPHEADER, chunk); curl_easy_setopt(curl, CURLOPT_POSTFIELDS, params.payload.data); curl_easy_setopt(curl, CURLOPT_NOBODY, 0L); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback); curl_easy_setopt(curl, CURLOPT_HEADERDATA, (void *)&resp_header); curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)&resp_body); //curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L); res = curl_easy_perform(curl); if (res != CURLE_OK) { fprintf(stderr, "curl_easy_perform() failed: %s\n", curl_easy_strerror(res)); } else { long status; curl_easy_getinfo(curl, CURLINFO_HTTP_CODE, &status); printf("status %d\n", status); printf(resp_header.memory); printf(resp_body.memory); } free(resp_header.memory); free(resp_body.memory); curl_easy_cleanup(curl); curl_global_cleanup(); //free signature params sig_params_free(¶ms); return 0; }
- Run the make command to obtain a main executable file, execute the file, and then view the execution result.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.