Skip to content

Support OAUTH and provide better error messages for zopen-setup #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MikeFultonDev merged 4 commits into from
Jan 21, 2023
Merged

Support OAUTH and provide better error messages for zopen-setup #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b4470f
use /bin/cp instead of cp since I need to copy datasets and can't use…
Jan 20, 2023
36e3ebd
remove message for expected path where extra header (for OAUTH) added
Jan 20, 2023
692d6f7
clean up download a bit
Jan 21, 2023
9f8f4f0
add special checks for 401 and 403 to give guidance
Jan 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tools/src/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ clean:
rm -f *.o zopen-setup

hwthic.h:
cp "//'sys1.sieahdrv.h(hwthic)'" hwthic.h
/bin/cp "//'sys1.sieahdrv.h(hwthic)'" hwthic.h

headers: hwthic.h

Expand Down
66 changes: 37 additions & 29 deletions tools/src/download.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,11 @@ char *DS_TYPE = "blocked"; /* TRSMAIN convention */
/****************************
* constants for http status
****************************/
#define HTTP_RC_OK 200
#define HTTP_RC_CREATED 201
#define HTTP_RC_REDIRECT 302 /* @GG*/
#define HTTP_RC_OK 200
#define HTTP_RC_CREATED 201
#define HTTP_RC_REDIRECT 302
#define HTTP_RC_UNAUTHORIZED 401
#define HTTP_RC_FORBIDDEN 403

/********************************
* variables and constants which
Expand Down Expand Up @@ -341,7 +343,6 @@ int toolkitSetOption( HWTH_RETURNCODE_TYPE *rcPtr,
uint32_t optionValueLength,
HWTH_DIAGAREA_TYPE *diagAreaPtr );

/* @GG start*/
int setRequestHeaders( HWTH_RETURNCODE_TYPE *rcPtr,
HWTH_HANDLE_TYPE *requestHandlePtr,
HWTH_DIAGAREA_TYPE *diagAreaPtr );
Expand All @@ -354,7 +355,6 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
char **stringRef,
uint32_t stringLength,
HWTH_DIAGAREA_TYPE *diagAreaPtr );
/* @GG end*/

#define MAX_TOKEN_PAYLOAD 16536 /* generous */
#define MAX_URI_LEN 511 /* generous */
Expand All @@ -364,6 +364,7 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
* Callbacks
**************/
HWTHRCVX recvexit; /* streaming receive */
int httpStatusCode; /* http status */
HWTHHDRX rhdrexit; /* response headers */

#ifdef HAS_MAIN
Expand All @@ -382,6 +383,7 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
struct parmStruct downloadParms = { false, IOTYPE_FILE, SCHEME_HTTPS };
#endif
char msgBuf[80];
int rc;

#ifdef HAS_MAIN
if ( getDownloadParms( argc, argv, &downloadParms ) ) {
Expand Down Expand Up @@ -417,10 +419,10 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
toolkitDisconnect( &connectHandle );
toolkitTerminate( &connectHandle );

summarize( &downloadParms,
&receiveData,
toolkitRc );
return toolkitRc;
summarize( &downloadParms, &receiveData, toolkitRc );

rc = checkHttpStatus(httpStatusCode);
return (rc == HTTP_RC_OK) ? 0 : rc;
} /* end main */


Expand Down Expand Up @@ -713,7 +715,6 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
return -1;
}

/* @GG just in case, set max redirects to the max */
intOption = 50;
if ( toolkitSetOption( &rc,
connectHandlePtr,
Expand All @@ -723,7 +724,7 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
&diagArea ) )
return -1;

/* @GG allow for cross domain redirects */
/* allow for cross domain redirects */
intOption = HWTH_XDOMAIN_REDIRS_ALLOWED;
if ( toolkitSetOption( &rc,
connectHandlePtr,
Expand Down Expand Up @@ -800,7 +801,6 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
&diagArea ) )
return -1;

/* @GG insert call to create request headers */
/*********************************************
* Set the request headers. This involves
* SList processing, done in called routines.
Expand Down Expand Up @@ -975,13 +975,15 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
*requestHandlePtr,
&diagArea );
if ( rc != HWTH_OK ) {
/* @GG the HWTH_WARNING with reason code 1 is due to a redirect*/
if (rc == HWTH_WARNING & diagArea.HWTH_reasonCode == 1) {
; /* MSF - this is expected trace("*INFO*: The request was successful, however FYI it involved a redirect."); */
rc = HWTH_OK;
/* The HWTH_WARNING with reason code 1 is due to a redirect */
/* This is not an issue - redirects are normal - no message needed */
if (rc == HWTH_WARNING && diagArea.HWTH_reasonCode == 1) {
rc = HWTH_OK;
} else {
trace("hwthrqst did not return an acceptable RC");
surfaceToolkitDiag( &rc, &diagArea );
if (rc != HWTH_WARNING) {
trace("hwthrqst did not return an acceptable RC");
surfaceToolkitDiag( &rc, &diagArea );
}
}
}
return rc;
Expand Down Expand Up @@ -1062,18 +1064,20 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
if ( pRecvData->numBytesReceived )
downloadSize = pRecvData->numBytesReceived;
else {
trace( "A full response was not received" );
if ( toolkitRc == HWTH_OK ) {
sprintf( msgBuf,
"Http response code %d was received",
pRecvData->httpStatusCode );
trace( msgBuf );
}
else {
#if 0
/* for things like forbidden or redirect, no message needed */
sprintf( msgBuf,
"Toolkit failure rc %d was received",
toolkitRc );
trace( msgBuf );
#endif
}
downloadSize = pRecvData->knownContentLength;
} /* endif lacking (full) response */
Expand Down Expand Up @@ -1362,8 +1366,8 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
if ( pUserData->httpStatusCode == 0 ) {
pStatusLine = pReceiveProgress->HWTH_responseStatusLine;
pUserData->httpStatusCode = (int)(pStatusLine->HWTH_statusCode);
if ( checkHttpStatus( pUserData->httpStatusCode ) ) {
rxtrace( "aborting (unacceptable Http status)" );
httpStatusCode = pUserData->httpStatusCode;
if (checkHttpStatus( pUserData->httpStatusCode ) != HTTP_RC_OK) {
*pReceiveState = HWTH_STREAM_RECEIVE_ABORT;
return;
} /* endif unacceptable http status code */
Expand Down Expand Up @@ -1537,25 +1541,30 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
* code (returned in the response headers) warrants
* receipt of the response body.
*
* Returns: 0 if acceptable status, -1 if not
* Returns: 0 if acceptable status, httpStatusCode if not
*******************************************************/
int checkHttpStatus( int httpStatusCode ) {
int rc = -1;
char msgBuf[80];

/* @GG - need to also handle the successful
case of redirect
*/
switch ( httpStatusCode ) {
case HTTP_RC_CREATED:
case HTTP_RC_OK:
case HTTP_RC_REDIRECT:
rc = 0;
rc = HTTP_RC_OK; /* map 'ok' stuff to rc_ok */
break;
case HTTP_RC_FORBIDDEN:
rc = HTTP_RC_FORBIDDEN;
break; /* this is an error - but we will not print a message about it */
case HTTP_RC_UNAUTHORIZED:
rc = HTTP_RC_UNAUTHORIZED;
break; /* this is an error - but we will not print a message about it */
default:
sprintf( msgBuf,
"Unexpected Http response code %d received",
httpStatusCode );
rc = httpStatusCode;

rxtrace( msgBuf );
break;
} /* end switch */
Expand Down Expand Up @@ -2105,7 +2114,8 @@ int toolkitSlistOperation( HWTH_RETURNCODE_TYPE *rcPtr,
* additional level(s) to increase the likelihood
* of acceptance by your web server.
**************************************************/
//HWTH_SSLVERSION_DEFAULT @GG
/* HWTH_SSLVERSION_DEFAULT is the default */

intOption = HWTH_SSLVERSION_TLSV12;
if ( toolkitSetOption( &rc,
connectHandlePtr,
Expand Down Expand Up @@ -2675,8 +2685,6 @@ int setRequestHeaders( HWTH_RETURNCODE_TYPE *rcPtr,
trace( "Slist append failure" );
return -1;
} /* endif slist append failed */
else
trace( "Next request header appended" );
} /* endloop thru remaining headers */

if ( toolkitSetOption( rcPtr,
Expand Down
14 changes: 13 additions & 1 deletion tools/src/httpsget.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,19 @@ int httpsget(const char* host, const char* uri, const char* pem, const char* out
}

if (rc = download(host, uri, output, keydb, stashfile)) {
fprintf(stderr, "error downloading https://%s%s to %s: %d\n", host, uri, output, rc);
if (rc == 403) {
fprintf(stderr, "You have received a 403 Forbidden error from %s%s\n", host, uri);
fprintf(stderr, "This is likely because you have exceeded your download quota from github.\n");
fprintf(stderr, "Please see: https://zosopentools.link/github-oauth for instructions on how to set up a github OAUTH id.\n");
fprintf(stderr, "Once your OAUTH id is set, export ZOPEN_GIT_OAUTH_TOKEN=<your token> and then re-run zopen-setup.\n");
} else if (rc == 401) {
fprintf(stderr, "You have received a 401 Unauthorized error from %s%s\n", host, uri);
fprintf(stderr, "This is likely because you have an expired or invalid github OAUTH id.\n");
fprintf(stderr, "Please see: https://zosopentools.link/github-oauth for instructions on how to set up a new github OAUTH id.\n");
fprintf(stderr, "Once your OAUTH id is reset, export ZOPEN_GIT_OAUTH_TOKEN=<your token> and then re-run zopen-setup.\n");
} else {
fprintf(stderr, "error downloading https://%s%s to %s: %d\n", host, uri, output, rc);
}
return rc;
}

Expand Down
8 changes: 2 additions & 6 deletions tools/src/zopensetupmain.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ int main(int argc, char* argv[]) {
return 4;
}

if (!tmppem || genfilename("pem", tmppem, ZOPEN_PATH_MAX)) {
fprintf(stderr, "error acquiring storage\n");
if (genfilename("pem", tmppem, ZOPEN_PATH_MAX)) {
/* genfilename issues specific errors */
return 4;
}

Expand All @@ -131,11 +131,9 @@ int main(int argc, char* argv[]) {
fprintf(STDTRC, "Download %s into %s/%s\n", bootpkg[i], root, ZOPEN_BOOT);
}
if (getfilenamefrompkg(bootpkg[i], pkgsfx, tmppem, filename, ZOPEN_PATH_MAX)) {
fprintf(stderr, "error acquiring storage (3)\n");
return 4;
}
if (genfilenameinsubdir(root, ZOPEN_BOOT, filename, output, ZOPEN_PATH_MAX)) {
fprintf(stderr, "error acquiring storage (2)\n");
return 4;
}
if ((rc = snprintf(uri, sizeof(uri), "/%s/%s%s/%s/%s", ZOPEN_BOOT_URI_PREFIX, bootpkg[i], pkgsfx, ZOPEN_BOOT_URI_SUFFIX, filename)) > sizeof(uri)) {
Expand All @@ -147,7 +145,6 @@ int main(int argc, char* argv[]) {
return rc;
}
if (rc = unpaxandlink(root, ZOPEN_BOOT, output, bootpkg[i])) {
fprintf(stderr, "error unpaxing %s in directory %s/%s\n", output, root, ZOPEN_BOOT);
return rc;
}
}
Expand All @@ -156,7 +153,6 @@ int main(int argc, char* argv[]) {
fprintf(STDTRC, "Create %s for source'ing in %s/%s\n", ZOPEN_BOOT_ENV, root, ZOPEN_BOOT);
}
if (rc = createbootenv(root, ZOPEN_BOOT, bootpkg)) {
fprintf(stderr, "error creating %s in directory %s/%s\n", ZOPEN_BOOT_ENV, root, ZOPEN_BOOT);
return rc;
}

Expand Down