/ - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 9533

Added by Chris Jones almost 9 years ago

dd the hasValidAuthToken() method to determine if the current token (if any) is valid. Use this and validateSession() within the script to determine if we need to call Metacat->login() or not. Add some minor debugging to work through the code stages using auth tokens.

refs https://github.nceas.ucsb.edu/KNB/arctic-data/issues/42

     	# None of the stages have been reached and data is not being confirmed.
     	# check if the user is logged in...
     	my $session = CGI::Session->load() or die CGI::Session->errstr();
     	if ( $session->is_empty ) {
     	if ( ! validateSession() ) {
     		# no session found ... redirect to login page template
     		$$templateVars{'showInstructions'} = 'true';
-...
     if ( !$error ) {
     	# Login to metacat
     	my ( $username, $password ) = getCredentials();
     	my $response = $metacat->login( $username, $password );
     	my $errorMessage = "";
     	# Login to metacat if there is no authentication token
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	my ( $username, $password ) = getCredentials();
         	$response = $metacat->login( $username, $password );
         	my $errorMessage = "";
+        }
     	# Parameters have been validated and Create the XML document
     	my $xmldoc = createXMLDocument();
-...
+    			}
+    		}
     		debug("A");
     		debug("Checking for a FORM docid.");
     		if ( $FORM::docid eq "" ) {
     			debug("B1");
     			debug("No FORM docid is present. Generating one from Metacat.");
     			# document is being inserted
     			my $docStatus = "INCOMPLETE";
-...
                     $xmldocWithDocID =~ s/docid/$docid/;
                     debugDoc($xmldocWithDocID);
                     $docStatus = insertMetadata( $xmldocWithDocID, $docid );
                     debug("B2");
+    			}
                 debug("B3");
                 if ( $docStatus ne "SUCCESS" ) {
                     debug("NO SUCCESS");
                     debug("Message is: $docStatus");
-...
+    		}
     		else {
     			debug("M1");
     			debug("The form has an existing docid: " . $FORM::docid);
     			# document is being modified
     			$docid = incrementRevision($FORM::docid);
-...
     			$xmldoc =~ s/docid/$docid/;
     			debugDoc($xmldoc);
                 debug('Updating docid: ' . $docid);
     			my $response = $metacat->update( $docid, $xmldoc );
     			if ( !$response ) {
-...
     				push( @errorMessages, "Failed while updating.\n" );
+    			}
     			debug("M2, $docid");
     			debug("Updated document with docid: $docid");
     			if ( scalar(@errorMessages) ) {
     				debug("Errors defined in modify.");
-...
+    }
     debug("C");
     if ( scalar(@errorMessages) ) {
     	debug("ErrorMessages defined.");
     	$$templateVars{'docid'} = $FORM::docid;
-...
     	debug("Trying to insert the following document");
     	my $docStatus = "SUCCESS";
     	debug("Starting insert of $docid (D1)");
     	debug("Starting insert of $docid");
     	my $response = $metacat->insert( $docid, $xmldoc );
     	if ( !$response ) {
     		debug("Response gotten (D2)");
     		debug("Response gotten for docid: " . $docid);
     		my $errormsg = $metacat->getMessage();
     		debug( "Error is (D3): " . $errormsg );
     		debug( "Error is: " . $errormsg );
     		if ( $errormsg =~ /is already in use/ ) {
     			$docStatus = "INCOMPLETE";
+    		}
-...
     			$docStatus = $errormsg;
+    		}
+    	}
     	debug("Ending insert (D4)");
     	debug("Ending insert of docid: " . $docid);
     	return $docStatus;
+    }
-...
+    	}
     	# Now the file is on disk, send the object to Metacat
     	my $session = CGI::Session->load();
     	if ( $session->is_empty ) {
     	if ( ! validateSession() ) {
     		push( @errorMessages, "Must be logged in to upload files." );
     		debug("Not logged in, cannot upload files.");
     		return 0;
-...
     sub deleteFileData {
     	my $input = shift;
     	my ( $docid, $fileHash ) = datafileInfo($input);
     	my $metacat = Metacat->new($metacatUrl);
     	my ($username, $password);
         my $metacat = Metacat->new($metacatUrl);
         setAuthToken($metacat);
     	my ( $username, $password ) = getCredentials();
     	my $response = $metacat->login( $username, $password );
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	( $username, $password ) = getCredentials();
         	$response = $metacat->login( $username, $password );
+        }
     	if ( !$response ) {
     		my $msg = $metacat->getMessage();
     		push( @errorMessages,
-...
     	my $filename = shift;
     	debug("Upload -- Starting upload of $docid");
     	my $response = $metacat->upload( $docid, $data, $filename );
     	if ( !$response ) {
-...
     	my $element;
     	my $tempfile;
     	my ( $username, $password ) = getCredentials();
     	$metacat->login( $username, $password );
         if ( ! hasValidAuthToken() ) {
             my ( $username, $password ) = getCredentials();
     	    $metacat->login( $username, $password );
+        }
     	$httpMessage = $metacat->read($docid);
     	$doc         = $httpMessage->content();
-...
     	# Login to metacat
     	my $errorMessage = "";
     	my ( $username, $password ) = getCredentials();
     	my $response = $metacat->login( $username, $password );
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	my ( $username, $password ) = getCredentials();
         	$response = $metacat->login( $username, $password );
+        }
     	if ( !$response ) {
-...
     	# Check if a session already exists
     	my $session = CGI::Session->load() or die CGI::Session->errstr();
     	if ( $session->is_empty ) {
     	if ( ! validateSession() ) { # tokens won't be involved in login()
     		# no session found ... check if the login is correct
     		my $username = $FORM::username;
     		my $password = $FORM::password;
     		my $metacat = Metacat->new($metacatUrl);
             setAuthToken($metacat);
     		my $returnVal = $metacat->login( $username, $password );
     		debug(
     "Login was $returnVal for login attempt to $metacatUrl, with $username"
     		);
         	my $returnVal = $metacat->login( $username, $password );
     		debug("Login was $returnVal for login " .
                   "attempt to $metacatUrl, with $username");
     		if ( $returnVal > 0 ) {
     			# valid username and passwd
-...
     	my $metacat = Metacat->new($metacatUrl);
     	setAuthToken($metacat);
     	my ( $username, $password ) = getCredentials();
     	$metacat->login( $username, $password );
         if ( ! hasValidAuthToken() ) {
         	my ( $username, $password ) = getCredentials();
         	$metacat->login( $username, $password );
+        }
     	my $userInfo = $metacat->getUserInfo($sessionId);
-...
     sub getReviewHistoryHTML {
     	my $metacat = Metacat->new($metacatUrl);
     	setAuthToken($metacat);
     	my ( $username, $password ) = getCredentials();
     	$metacat->login( $username, $password );
         if ( ! hasValidAuthToken() ) {
         	my ( $username, $password ) = getCredentials();
         	$metacat->login( $username, $password );
+        }
     	my $parser = XML::LibXML->new();
     	my $docid  = $FORM::docid;
     	my ( $x, $y, $z ) = split( /\./, $docid );
-...
     	my $userDN              = '';
     	# Log into metacat
     	my $response = $metacat->login( $modUsername, $modPassword );
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	$response = $metacat->login( $modUsername, $modPassword );
+        }
     	my $docid = $FORM::docid;
     	if ( !$response ) {
-...
     	my $title;
     	# Log into metacat
     	my $response = $metacat->login( $modUsername, $modPassword );
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	$response = $metacat->login( $modUsername, $modPassword );
+        }
     	if ( !$response ) {
-...
     	my $userDN = '';
     	# Log into metacat
     	my $response = $metacat->login( $modUsername, $modPassword );
         my $response = hasValidAuthToken();
         if ( ! $response ) {
         	$response = $metacat->login( $modUsername, $modPassword );
+        }
     	if ( !$response ) {
-...
     sub setAuthToken() {
         my $metacat = shift;
         if ( $debug_enabled ) {
             debug('setAuthToken() called.');
+        }
         eval { $metacat->isa('Metacat'); };
         if ( ! $@ ) {
-...
             if ( $ENV{'HTTP_AUTHORIZATION'}) {
                 $metacat->set_options(
                     auth_token_header => $ENV{'HTTP_AUTHORIZATION'});
             } else {
                 if ( $debug_enabled ) {
                     debug("There is no HTTP_AUTHORIZATION variable. " .
                           "Did not set Metacat->{'auth_token_header'}");
+                }
+            }
         } else {
             debug('Not an instance of Metacat.' .
             'Pass a Metacat object only to setAuthToken()');
             'Pass a Metacat object only to setAuthToken().');
+        }
+    }
-...
+    #
     ################################################################################
     sub getSigningCertificate() {
         if ( $debug_enabled ) {
             debug('getSigningCertificate called.');
+        }
         open(my $pem_cert_file, ">", $pem_file_path)
             or die "\nCould not open PEM certificate file: $!\n";
-...
             "-out", $der_file_path, "-outform", "DER");
         system(@convert_der_args);
         # For debugging, display the cert details
         if ( $debug_enabled ) {
             my @cert_info = `openssl x509 -noout -issuer -subject -dates -in $pem_file_path`;
             debug("Signing certificate info: ");
             for my $info_line (@cert_info) {
                 debug($info_line);
+            }
+        }
+    }
     ################################################################################
-...
     ################################################################################
     sub getTokenInfo() {
         # Initialize the token info hash
         if ( $debug_enabled ) {
             debug('getTokenInfo() called.');
+        }
         my $token_info = {
                 userId      => '',
                 issuedAt    => '',
-...
         if ( $ENV{'HTTP_AUTHORIZATION'} ) {
             my @token_parts = split(/ /, $ENV{'HTTP_AUTHORIZATION'});
             $token = @token_parts[1];
+        }
         my $der_cert_file;
-...
+        }
         # Read the DER-encoded certificate
         open($der_cert_file, "<", $cn . ".der")
         open($der_cert_file, "<", $der_file_path)
             or die "\nCould not open DER certificate file: $!\n";
         binmode($der_cert_file);
         read($der_cert_file, $signing_cert, 4096)
-...
         close($der_cert_file);
         my $cert = Crypt::X509->new(cert=>$signing_cert);
         # Decode the token using Crypt::JWT
         eval{ $token_info = decode_jwt(token=>$token, key=>$cert); };
         eval{ $token_info = decode_jwt(token=>$token, key=>$cert) };
         if ( ! $@ ) {
             $$token_info{isValid} = 1;
         } else {
             debug($@);
+        }
         return $token_info;
-...
             debug('validateSession() called.');
+        }
         my %token_info = getTokenInfo();
         my $token_info = getTokenInfo();
         my $session = CGI::Session->load();
         my $valid = 0;
         if ( $token_info{'isValid'} ) {
         if ( $token_info->{"isValid"} ) {
             $valid = 1;
             if ( $debug_enabled ) {
                     debug('The auth token session is valid.');
-...
+            }
+        }
         if ( $debug_enabled ) {
             while( my ($k, $v) = each %$token_info ) {
                 debug("$k: $v");
+            }
+        }
         return $valid;
+    }
     ################################################################################
+    #
     # Determine if the current authentication token is valid
+    #
     ################################################################################
     sub hasValidAuthToken() {
         if ( $debug_enabled ) {
             debug('hasValidAuthToken() called.');
+        }
         my $token_info = getTokenInfo();
         if ( $debug_enabled ) {
             debug("Auth token is valid: $token_info->{'isValid'}");
+        }
         return $token_info->{'isValid'};
+    }

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 9533

Added by Chris Jones almost 9 years ago