xref: /petsc/src/sys/webclient/google.c (revision 9371c9d470a9602b6d10a8bf50c9b2280a79e45a)
1 
2 #include <petscwebclient.h>
3 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
4 #pragma gcc diagnostic   ignored "-Wdeprecated-declarations"
5 
6 /*
7    These variables identify the code as a PETSc application to Google.
8 
9    See -   https://stackoverflow.com/questions/4616553/using-oauth-in-free-open-source-software
10    Users can get their own application IDs - https://code.google.com/p/google-apps-manager/wiki/GettingAnOAuthConsoleKey
11 
12 */
13 #define PETSC_GOOGLE_CLIENT_ID "521429262559-i19i57eek8tnt9ftpp4p91rcl0bo9ag5.apps.googleusercontent.com"
14 #define PETSC_GOOGLE_CLIENT_ST "vOds_A71I3_S_aHMq_kZAI0t"
15 #define PETSC_GOOGLE_API_KEY   "AIzaSyDRZsOcySpWVzsUvIBL2UG3J2tcg-MXbyk"
16 
17 /*@C
18      PetscGoogleDriveRefresh - Get a new authorization token for accessing Google drive from PETSc from a refresh token
19 
20    Not collective, only the first process in the MPI_Comm does anything
21 
22    Input Parameters:
23 +   comm - MPI communicator
24 .   refresh token - obtained with PetscGoogleDriveAuthorize(), if NULL PETSc will first look for one in the options data
25                     if not found it will call PetscGoogleDriveAuthorize()
26 -   tokensize - size of the output string access_token
27 
28    Output Parameter:
29 .   access_token - token that can be passed to PetscGoogleDriveUpload()
30 
31    Options Database:
32 .  -google_refresh_token XXX - where XXX was obtained from PetscGoogleDriveAuthorize()
33 
34    Level: intermediate
35 
36 .seealso: `PetscURLShorten()`, `PetscGoogleDriveAuthorize()`, `PetscGoogleDriveUpload()`
37 
38 @*/
39 PetscErrorCode PetscGoogleDriveRefresh(MPI_Comm comm, const char refresh_token[], char access_token[], size_t tokensize) {
40   SSL_CTX    *ctx;
41   SSL        *ssl;
42   int         sock;
43   char        buff[8 * 1024], body[1024];
44   PetscMPIInt rank;
45   char       *refreshtoken = (char *)refresh_token;
46   PetscBool   found;
47 
48   PetscFunctionBegin;
49   PetscCallMPI(MPI_Comm_rank(comm, &rank));
50   if (rank == 0) {
51     if (!refresh_token) {
52       PetscBool set;
53       PetscCall(PetscMalloc1(512, &refreshtoken));
54       PetscCall(PetscOptionsGetString(NULL, NULL, "-google_refresh_token", refreshtoken, sizeof(refreshtoken), &set));
55       if (!set) {
56         PetscCall(PetscGoogleDriveAuthorize(comm, access_token, refreshtoken, 512 * sizeof(char)));
57         PetscCall(PetscFree(refreshtoken));
58         PetscFunctionReturn(0);
59       }
60     }
61     PetscCall(PetscSSLInitializeContext(&ctx));
62     PetscCall(PetscHTTPSConnect("accounts.google.com", 443, ctx, &sock, &ssl));
63     PetscCall(PetscStrcpy(body, "client_id="));
64     PetscCall(PetscStrcat(body, PETSC_GOOGLE_CLIENT_ID));
65     PetscCall(PetscStrcat(body, "&client_secret="));
66     PetscCall(PetscStrcat(body, PETSC_GOOGLE_CLIENT_ST));
67     PetscCall(PetscStrcat(body, "&refresh_token="));
68     PetscCall(PetscStrcat(body, refreshtoken));
69     if (!refresh_token) PetscCall(PetscFree(refreshtoken));
70     PetscCall(PetscStrcat(body, "&grant_type=refresh_token"));
71 
72     PetscCall(PetscHTTPSRequest("POST", "accounts.google.com/o/oauth2/token", NULL, "application/x-www-form-urlencoded", body, ssl, buff, sizeof(buff)));
73     PetscCall(PetscSSLDestroyContext(ctx));
74     close(sock);
75 
76     PetscCall(PetscPullJSONValue(buff, "access_token", access_token, tokensize, &found));
77     PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_LIB, "Google drive did not return access_token");
78   }
79   PetscFunctionReturn(0);
80 }
81 
82 #include <sys/stat.h>
83 
84 /*@C
85      PetscGoogleDriveUpload - Loads a file to the Google Drive
86 
87      Not collective, only the first process in the MPI_Comm uploads the file
88 
89   Input Parameters:
90 +   comm - MPI communicator
91 .   access_token - obtained with PetscGoogleDriveRefresh(), pass NULL to have PETSc generate one
92 -   filename - file to upload; if you upload multiple times it will have different names each time on Google Drive
93 
94   Options Database:
95 .  -google_refresh_token XXX - pass the access token for the operation
96 
97   Usage Patterns:
98     With PETSc option -google_refresh_token  XXX given
99     PetscGoogleDriveUpload(comm,NULL,filename);        will upload file with no user interaction
100 
101     Without PETSc option -google_refresh_token XXX given
102     PetscGoogleDriveUpload(comm,NULL,filename);        for first use will prompt user to authorize access to Google Drive with their browser
103 
104     With PETSc option -google_refresh_token  XXX given
105     PetscGoogleDriveRefresh(comm,NULL,access_token,sizeof(access_token));
106     PetscGoogleDriveUpload(comm,access_token,filename);
107 
108     With refresh token entered in some way by the user
109     PetscGoogleDriveRefresh(comm,refresh_token,access_token,sizeof(access_token));
110     PetscGoogleDriveUpload(comm,access_token,filename);
111 
112     PetscGoogleDriveAuthorize(comm,access_token,refresh_token,sizeof(access_token));
113     PetscGoogleDriveUpload(comm,access_token,filename);
114 
115    Level: intermediate
116 
117 .seealso: `PetscURLShorten()`, `PetscGoogleDriveAuthorize()`, `PetscGoogleDriveRefresh()`
118 
119 @*/
120 PetscErrorCode PetscGoogleDriveUpload(MPI_Comm comm, const char access_token[], const char filename[]) {
121   SSL_CTX    *ctx;
122   SSL        *ssl;
123   int         sock;
124   char        head[1024], buff[8 * 1024], *body, *title;
125   PetscMPIInt rank;
126   struct stat sb;
127   size_t      len, blen, rd;
128   FILE       *fd;
129   int         err;
130 
131   PetscFunctionBegin;
132   PetscCallMPI(MPI_Comm_rank(comm, &rank));
133   if (rank == 0) {
134     PetscCall(PetscStrcpy(head, "Authorization: Bearer "));
135     PetscCall(PetscStrcat(head, access_token));
136     PetscCall(PetscStrcat(head, "\r\n"));
137     PetscCall(PetscStrcat(head, "uploadType: multipart\r\n"));
138 
139     err = stat(filename, &sb);
140     PetscCheck(!err, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to stat file: %s", filename);
141     len = 1024 + sb.st_size;
142     PetscCall(PetscMalloc1(len, &body));
143     PetscCall(PetscStrcpy(body, "--foo_bar_baz\r\n"
144                                 "Content-Type: application/json\r\n\r\n"
145                                 "{"));
146     PetscCall(PetscPushJSONValue(body, "title", filename, len));
147     PetscCall(PetscStrcat(body, ","));
148     PetscCall(PetscPushJSONValue(body, "mimeType", "text.html", len));
149     PetscCall(PetscStrcat(body, ","));
150     PetscCall(PetscPushJSONValue(body, "description", "a file", len));
151     PetscCall(PetscStrcat(body, "}\r\n\r\n"
152                                 "--foo_bar_baz\r\n"
153                                 "Content-Type: text/html\r\n\r\n"));
154     PetscCall(PetscStrlen(body, &blen));
155     fd = fopen(filename, "r");
156     PetscCheck(fd, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to open file: %s", filename);
157     rd = fread(body + blen, sizeof(unsigned char), sb.st_size, fd);
158     PetscCheck(rd == (size_t)sb.st_size, PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Unable to read entire file: %s %d %d", filename, (int)rd, (int)sb.st_size);
159     fclose(fd);
160     body[blen + rd] = 0;
161     PetscCall(PetscStrcat(body, "\r\n\r\n"
162                                 "--foo_bar_baz\r\n"));
163     PetscCall(PetscSSLInitializeContext(&ctx));
164     PetscCall(PetscHTTPSConnect("www.googleapis.com", 443, ctx, &sock, &ssl));
165     PetscCall(PetscHTTPSRequest("POST", "www.googleapis.com/upload/drive/v2/files/", head, "multipart/related; boundary=\"foo_bar_baz\"", body, ssl, buff, sizeof(buff)));
166     PetscCall(PetscFree(body));
167     PetscCall(PetscSSLDestroyContext(ctx));
168     close(sock);
169     PetscCall(PetscStrstr(buff, "\"title\"", &title));
170     PetscCheck(title, PETSC_COMM_SELF, PETSC_ERR_LIB, "Upload of file %s failed", filename);
171   }
172   PetscFunctionReturn(0);
173 }
174 
175 #if defined(PETSC_HAVE_UNISTD_H)
176 #include <unistd.h>
177 #endif
178 
179 /*@C
180      PetscGoogleDriveAuthorize - Get authorization and refresh token for accessing Google drive from PETSc
181 
182    Not collective, only the first process in MPI_Comm does anything
183 
184    Input Parameters:
185 +  comm - the MPI communicator
186 -  tokensize - size of the token arrays
187 
188    Output Parameters:
189 +  access_token - can be used with PetscGoogleDriveUpload() for this one session
190 -  refresh_token - can be used for ever to obtain new access_tokens with PetscGoogleDriveRefresh(), guard this like a password
191                    it gives access to your Google Drive
192 
193    Notes:
194     This call requires stdout and stdin access from process 0 on the MPI communicator
195 
196    You can run src/sys/webclient/tutorials/googleobtainrefreshtoken to get a refresh token and then in the future pass it to
197    PETSc programs with -google_refresh_token XXX
198 
199    Level: intermediate
200 
201 .seealso: `PetscGoogleDriveRefresh()`, `PetscGoogleDriveUpload()`, `PetscURLShorten()`
202 
203 @*/
204 PetscErrorCode PetscGoogleDriveAuthorize(MPI_Comm comm, char access_token[], char refresh_token[], size_t tokensize) {
205   SSL_CTX    *ctx;
206   SSL        *ssl;
207   int         sock;
208   char        buff[8 * 1024], *ptr, body[1024];
209   PetscMPIInt rank;
210   size_t      len;
211   PetscBool   found;
212 
213   PetscFunctionBegin;
214   PetscCallMPI(MPI_Comm_rank(comm, &rank));
215   if (rank == 0) {
216     PetscCheck(isatty(fileno(PETSC_STDOUT)), PETSC_COMM_SELF, PETSC_ERR_USER, "Requires users input/output");
217     PetscCall(PetscPrintf(comm, "Cut and paste the following into your browser:\n\n"
218                                 "https://accounts.google.com/o/oauth2/auth?"
219                                 "scope=https%%3A%%2F%%2Fwww.googleapis.com%%2Fauth%%2Fdrive.file&"
220                                 "redirect_uri=urn:ietf:wg:oauth:2.0:oob&"
221                                 "response_type=code&"
222                                 "client_id=" PETSC_GOOGLE_CLIENT_ID "\n\n"));
223     PetscCall(PetscPrintf(comm, "Paste the result here:"));
224     ptr = fgets(buff, 1024, stdin);
225     PetscCheck(ptr, PETSC_COMM_SELF, PETSC_ERR_FILE_READ, "Error reading from stdin: %d", errno);
226     PetscCall(PetscStrlen(buff, &len));
227     buff[len - 1] = 0; /* remove carriage return at end of line */
228 
229     PetscCall(PetscSSLInitializeContext(&ctx));
230     PetscCall(PetscHTTPSConnect("accounts.google.com", 443, ctx, &sock, &ssl));
231     PetscCall(PetscStrcpy(body, "code="));
232     PetscCall(PetscStrcat(body, buff));
233     PetscCall(PetscStrcat(body, "&client_id="));
234     PetscCall(PetscStrcat(body, PETSC_GOOGLE_CLIENT_ID));
235     PetscCall(PetscStrcat(body, "&client_secret="));
236     PetscCall(PetscStrcat(body, PETSC_GOOGLE_CLIENT_ST));
237     PetscCall(PetscStrcat(body, "&redirect_uri=urn:ietf:wg:oauth:2.0:oob&"));
238     PetscCall(PetscStrcat(body, "grant_type=authorization_code"));
239 
240     PetscCall(PetscHTTPSRequest("POST", "accounts.google.com/o/oauth2/token", NULL, "application/x-www-form-urlencoded", body, ssl, buff, sizeof(buff)));
241     PetscCall(PetscSSLDestroyContext(ctx));
242     close(sock);
243 
244     PetscCall(PetscPullJSONValue(buff, "access_token", access_token, tokensize, &found));
245     PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_LIB, "Google drive did not return access_token");
246     PetscCall(PetscPullJSONValue(buff, "refresh_token", refresh_token, tokensize, &found));
247     PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_LIB, "Google drive did not return refresh_token");
248 
249     PetscCall(PetscPrintf(comm, "Here is your Google refresh token, save it in a save place, in the future you can run PETSc\n"));
250     PetscCall(PetscPrintf(comm, "programs with the option -google_refresh_token %s\n", refresh_token));
251     PetscCall(PetscPrintf(comm, "to access Google Drive automatically\n"));
252   }
253   PetscFunctionReturn(0);
254 }
255 
256 /*@C
257      PetscURLShorten - Uses Google's service to get a short url for a long url
258 
259     Input Parameters:
260 +    url - long URL you want shortened
261 -    lenshorturl - length of buffer to contain short URL
262 
263     Output Parameter:
264 .    shorturl - the shortened URL
265 
266    Level: intermediate
267 
268 .seealso: `PetscGoogleDriveRefresh()`, `PetscGoogleDriveUpload()`, `PetscGoogleDriveAuthorize()`
269 @*/
270 PetscErrorCode PetscURLShorten(const char url[], char shorturl[], size_t lenshorturl) {
271   SSL_CTX  *ctx;
272   SSL      *ssl;
273   int       sock;
274   char      buff[1024], body[512], post[1024];
275   PetscBool found;
276 
277   PetscFunctionBegin;
278   PetscCall(PetscSSLInitializeContext(&ctx));
279   PetscCall(PetscHTTPSConnect("www.googleapis.com", 443, ctx, &sock, &ssl));
280   PetscCall(PetscStrcpy(body, "{"));
281   PetscCall(PetscPushJSONValue(body, "longUrl", url, sizeof(body) - 2));
282   PetscCall(PetscStrcat(body, "}"));
283   PetscCall(PetscSNPrintf(post, sizeof(post), "www.googleapis.com/urlshortener/v1/url?key=%s", PETSC_GOOGLE_API_KEY));
284   PetscCall(PetscHTTPSRequest("POST", post, NULL, "application/json", body, ssl, buff, sizeof(buff)));
285   PetscCall(PetscSSLDestroyContext(ctx));
286   close(sock);
287 
288   PetscCall(PetscPullJSONValue(buff, "id", shorturl, lenshorturl, &found));
289   PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_LIB, "Google drive did not return short URL");
290   PetscFunctionReturn(0);
291 }
292