Merge pull request #41 from negrutiu/feature/GH-40-cookies

Feature/gh 40 cookies

Author: negrutiu

src/nscurl/NScurl.readme.md

@@ -157,6 +157,14 @@ Examples:
 > [!note]
 > DoH server is used for the current transfer only, it's not a global setting
 
+### /COOKIEJAR
+```
+/COOKIEJAR "filepath"
+```
+Specify a custom file where libcurl stores cookies.  
+By default `$PLUGINSDIR\cookies.txt` is used.  
+Specifying an empty string disables cookie engine.
+
 ### /TIMEOUT
 ### /CONNECTTIMEOUT
 ```

src/nscurl/curl.c

@@ -21,6 +21,64 @@ CURL_GLOBALS g_Curl = {0};
 //x #define DEBUG_TRANSFER_SLOWDOWN		50						/// Delays during transfer
 
 
+void CurlRequestInit(_Inout_ PCURL_REQUEST pReq)
+{
+	if (!pReq) return;
+	ZeroMemory(pReq, sizeof(*pReq));
+	pReq->Runtime.iRootCertFlags = (ULONG)-1;	// Uninitialized
+	pReq->bCastore = TRUE;
+	{
+		TCHAR buffer[MAX_PATH];
+		_sntprintf(buffer, ARRAYSIZE(buffer), _T("%s\\cookies.txt"), getuservariableEx(INST_PLUGINSDIR));
+		pReq->pszCookieFile = MyStrDup(eT2A, buffer);
+	}
+}
+
+void CurlRequestDestroy(_Inout_ PCURL_REQUEST pReq)
+{
+	if (!pReq) return;
+	MyFree(pReq->pszURL);
+	MyFree(pReq->pszPath);
+	MyFree(pReq->pszMethod);
+	MyFree(pReq->pszProxy);
+	MyFree(pReq->pszProxyUser);
+	MyFree(pReq->pszProxyPass);
+	MyFree(pReq->pszUser);
+	MyFree(pReq->pszPass);
+	MyFree(pReq->pszTlsUser);
+	MyFree(pReq->pszTlsPass);
+	curl_slist_free_all(pReq->pOutHeaders);
+	curl_slist_free_all(pReq->pPostVars);
+	IDataDestroy(&pReq->Data);
+	MyFree(pReq->pszAgent);
+	MyFree(pReq->pszReferrer);
+	curl_slist_free_all(pReq->pCertList);
+	curl_slist_free_all(pReq->pPemList);
+	MyFree(pReq->pszCacert);
+	MyFree(pReq->pszDebugFile);
+	MyFree(pReq->pszTag);
+	MyFree(pReq->pszDOH);
+	MyFree(pReq->pszCookieFile);
+	pReq->Runtime.pCurl = NULL;
+	if (MyValidHandle(pReq->Runtime.hInFile))
+		CloseHandle(pReq->Runtime.hInFile);
+	if (MyValidHandle(pReq->Runtime.hOutFile))
+		CloseHandle(pReq->Runtime.hOutFile);
+	if (MyValidHandle(pReq->Runtime.hDebugFile))
+		CloseHandle(pReq->Runtime.hDebugFile);
+	VirtualMemoryDestroy(&pReq->Runtime.InHeaders);
+	VirtualMemoryDestroy(&pReq->Runtime.OutHeaders);
+	VirtualMemoryDestroy(&pReq->Runtime.OutData);
+	MyFree(pReq->Runtime.pszFinalURL);
+	MyFree(pReq->Runtime.pszServerIP);
+	MyFree(pReq->Error.pszWin32);
+	MyFree(pReq->Error.pszCurl);
+	MyFree(pReq->Error.pszX509);
+	MyFree(pReq->Error.pszHttp);
+	ZeroMemory(pReq, sizeof(*pReq));
+}
+
+
 //+ CurlRequestComputeNumbers
 void CurlRequestComputeNumbers( _In_ PCURL_REQUEST pReq, _Out_opt_ PULONG64 piSizeTotal, _Out_opt_ PULONG64 piSizeXferred, _Out_opt_ PSHORT piPercent, _Out_opt_ PBOOL pbDown )
 {
@@ -548,6 +606,12 @@ ULONG CurlParseRequestParam( _In_ ULONG iParamIndex, _In_ LPTSTR pszParam, _In_
 			if (*pszParam)
 				pReq->pszDOH = MyStrDup( eT2A, pszParam );
 		}
+	} else if (lstrcmpi( pszParam, _T( "/COOKIEJAR" ) ) == 0) {
+		if (popstring( pszParam ) == NOERROR) {
+			MyFree( pReq->pszCookieFile );
+			if (pszParam && pszParam[0])
+				pReq->pszCookieFile = MyStrDup( eT2A, pszParam );
+		}
 	} else if (lstrcmpi( pszParam, _T( "/ENCODING" ) ) == 0 || lstrcmpi( pszParam, _T( "/accept-encoding" ) ) == 0) {
 		pReq->bEncoding = TRUE;
 	} else {
@@ -1126,6 +1190,11 @@ void CurlTransfer( _In_ PCURL_REQUEST pReq )
 			if (pReq->pszDOH)
 				curl_easy_setopt( curl, CURLOPT_DOH_URL, pReq->pszDOH );
 
+			if (pReq->pszCookieFile && pReq->pszCookieFile[0]) {
+				curl_easy_setopt(curl, CURLOPT_COOKIEFILE, pReq->pszCookieFile);	// request cookies
+				curl_easy_setopt(curl, CURLOPT_COOKIEJAR, pReq->pszCookieFile);		// response cookies
+			}
+
 			if (pReq->bEncoding && !pReq->bResume && lstrcmpi(pReq->pszPath, FILENAME_MEMORY) != 0)
 			    curl_easy_setopt( curl, CURLOPT_ACCEPT_ENCODING, "" );		// Send Accept-Encoding header with all supported encodings
 
@@ -1441,8 +1510,7 @@ void CurlTransfer( _In_ PCURL_REQUEST pReq )
 			}
 
 			// Cleanup
-			curl_easy_reset( curl );
-			curl_easy_cleanup( curl );		// TODO: Return to cache
+			curl_easy_cleanup( curl );
 		}
 
 		curl_mime_free( form );

src/nscurl/curl.h

@@ -58,6 +58,7 @@ typedef struct _CURL_REQUEST {
 	ULONG		iDependencyId;			/// can be 0. This request will not be carried out until its dependency completes
 	LPCSTR		pszTag;					/// can be NULL
 	LPCSTR		pszDOH;					/// can be NULL. DNS-over-HTTPS server (e.g. "https://1.1.1.1/dns-query")
+	LPCSTR		pszCookieFile;
 	struct {
 		struct _CURL_REQUEST* pNext;	/// Singly linked list
 		ULONG			iId;			/// Unique ID
@@ -103,56 +104,12 @@ typedef struct _CURL_REQUEST {
 	} Error;
 } CURL_REQUEST, *PCURL_REQUEST;
 
+
 //+ CurlRequestInit
-static void CurlRequestInit( _Inout_ PCURL_REQUEST pReq ) {
-	if (!pReq) return;
-	ZeroMemory( pReq, sizeof( *pReq ) );
-	pReq->Runtime.iRootCertFlags = (ULONG)-1;	// Uninitialized
-	pReq->bCastore = TRUE;
-}
+void CurlRequestInit( _Inout_ PCURL_REQUEST pReq );
 
 //+ CurlRequestDestroy
-static void CurlRequestDestroy( _Inout_ PCURL_REQUEST pReq ) {
-	if (!pReq) return;
-	MyFree( pReq->pszURL );
-	MyFree( pReq->pszPath );
-	MyFree( pReq->pszMethod );
-	MyFree( pReq->pszProxy );
-	MyFree( pReq->pszProxyUser );
-	MyFree( pReq->pszProxyPass );
-	MyFree( pReq->pszUser );
-	MyFree( pReq->pszPass );
-	MyFree( pReq->pszTlsUser );
-	MyFree( pReq->pszTlsPass );
-	curl_slist_free_all( pReq->pOutHeaders );
-	curl_slist_free_all( pReq->pPostVars );
-	IDataDestroy( &pReq->Data );
-	MyFree( pReq->pszAgent );
-	MyFree( pReq->pszReferrer );
-	curl_slist_free_all( pReq->pCertList );
-	curl_slist_free_all( pReq->pPemList );
-	MyFree( pReq->pszCacert );
-	MyFree( pReq->pszDebugFile );
-	MyFree( pReq->pszTag );
-	MyFree( pReq->pszDOH );
-	pReq->Runtime.pCurl = NULL;
-	if (MyValidHandle( pReq->Runtime.hInFile ))
-		CloseHandle( pReq->Runtime.hInFile );
-	if (MyValidHandle( pReq->Runtime.hOutFile ))
-		CloseHandle( pReq->Runtime.hOutFile );
-	if (MyValidHandle( pReq->Runtime.hDebugFile ))
-		CloseHandle( pReq->Runtime.hDebugFile );
-	VirtualMemoryDestroy( &pReq->Runtime.InHeaders );
-	VirtualMemoryDestroy( &pReq->Runtime.OutHeaders );
-	VirtualMemoryDestroy( &pReq->Runtime.OutData );
-	MyFree( pReq->Runtime.pszFinalURL );
-	MyFree( pReq->Runtime.pszServerIP );
-	MyFree( pReq->Error.pszWin32 );
-	MyFree( pReq->Error.pszCurl );
-	MyFree( pReq->Error.pszX509 );
-	MyFree( pReq->Error.pszHttp );
-	ZeroMemory( pReq, sizeof( *pReq ) );
-}
+void CurlRequestDestroy( _Inout_ PCURL_REQUEST pReq );
 
 //+ CurlRequestSetAbortFlag
 #define CurlRequestSetAbortFlag( pReq ) \

tests/NScurl-Debug.nsi

@@ -206,6 +206,42 @@ Section "httpbin.org/get"
 SectionEnd
 
 
+Section "httpbun.com/cookies/set"
+	SectionIn ${INSTTYPE_MOST}
+	DetailPrint '=====[ ${__SECTION__} ]==============================='
+
+	!insertmacro STACK_VERIFY_START
+	!define /redef LINK 'https://httpbun.com/cookies/set?cookie1=value1&cookie2=value2'
+	!define /redef FILE '$EXEDIR\_GET_httpbun_cookies_set'
+    !define /redef JAR  '$EXEDIR\_GET_httpbun_cookiejar.txt'
+	DetailPrint 'NScurl::http "${LINK}" "${FILE}"'
+
+	Push "/END"
+
+	; Push "${FILE}.md"
+	; Push /DEBUG
+
+    Push "${JAR}"
+    Push "/COOKIEJAR"
+
+	Push "${FILE}"
+	Push "${LINK}"
+	Push "GET"
+	CallInstDLL $DLL http
+	Pop $0
+
+    ${If} ${FileExists} "${JAR}"
+        StrCpy $1 "OK (file exists)"
+    ${Else}
+        StrCpy $1 "FAIL (not found: ${JAR})"
+    ${EndIf}
+
+	DetailPrint "Status: $0"
+	DetailPrint "Cookie jar: $1"
+	!insertmacro STACK_VERIFY_END
+SectionEnd
+
+
 Section "sysinternals.com/get (Page-Mode)"
 	SectionIn ${INSTTYPE_MOST}
 	DetailPrint '=====[ ${__SECTION__} ]==============================='

tests/NScurl-Test.nsi

@@ -149,6 +149,29 @@ Section "httpbin.org/get"
 SectionEnd
 
 
+Section "httpbun.com/cookies/set"
+	SectionIn ${INSTTYPE_MOST}
+	DetailPrint '=====[ ${__SECTION__} ]==============================='
+
+	!define /redef LINK 'https://httpbun.com/cookies/set?cookie1=value1&cookie2=value2'
+	!define /redef FILE '$EXEDIR\_GET_httpbun_cookies_set'
+    !define /redef JAR  '$EXEDIR\_GET_httpbun_cookiejar.txt'
+	DetailPrint 'NScurl::http "${LINK}" "${FILE}"'
+
+    NScurl::http get "${LINK}" "${FILE}" /COOKIEJAR "${JAR}" /END
+	Pop $0
+
+    ${If} ${FileExists} "${JAR}"
+        StrCpy $1 "OK (file exists)"
+    ${Else}
+        StrCpy $1 "FAIL (not found: ${JAR})"
+    ${EndIf}
+
+	DetailPrint "Status: $0"
+	DetailPrint "Cookie jar: $1"
+SectionEnd
+
+
 Section "sysinternals.com/get (Page-Mode)"
 	SectionIn ${INSTTYPE_MOST}
 	DetailPrint '=====[ ${__SECTION__} ]==============================='
@@ -416,10 +439,10 @@ SectionGroup /e "Tests"
 ; Valid to: ‎Sunday, ‎August ‎9, ‎2026 7:09:21 PM
 !define BADSSL_SELFSIGNED_CRT \
 "-----BEGIN CERTIFICATE-----$\n\
-MIIDeTCCAmGgAwIBAgIJAPhNZrCAQp0/MA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNV$\n\
+MIIDeTCCAmGgAwIBAgIJALfFORhDXiFeMA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNV$\n\
 BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp$\n\
 c2NvMQ8wDQYDVQQKDAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTAeFw0y$\n\
-NDA4MjAxNjI0NDVaFw0yNjA4MjAxNjI0NDVaMGIxCzAJBgNVBAYTAlVTMRMwEQYD$\n\
+NDEyMTkyMTAzMzNaFw0yNjEyMTkyMTAzMzNaMGIxCzAJBgNVBAYTAlVTMRMwEQYD$\n\
 VQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ8wDQYDVQQK$\n\
 DAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTCCASIwDQYJKoZIhvcNAQEB$\n\
 BQADggEPADCCAQoCggEBAMIE7PiM7gTCs9hQ1XBYzJMY61yoaEmwIrX5lZ6xKyx2$\n\
@@ -429,15 +452,15 @@ xPxTuW1CrbV8/q71FdIzSOciccfCFHpsKOo3St/qbLVytH5aohbcabFXRNsKEqve$\n\
 ww9HdFxBIuGa+RuT5q0iBikusbpJHAwnnqP7i/dAcgCskgjZjFeEU4EFy+b+a1SY$\n\
 QCeFxxC7c3DvaRhBB0VVfPlkPz0sw6l865MaTIbRyoUCAwEAAaMyMDAwCQYDVR0T$\n\
 BAIwADAjBgNVHREEHDAaggwqLmJhZHNzbC5jb22CCmJhZHNzbC5jb20wDQYJKoZI$\n\
-hvcNAQELBQADggEBAF9F2x4tuIATEa5jZY86nEaa3Py2Rd0tjNywlryS1TKXWIqu$\n\
-yim+0HpNU/R6cpkN1MZ1iN7dUKTtryLJIAXgaZC1TC6sRyuOMzV/rDHShT3WY0MW$\n\
-+/sebaJZ4kkLUzQ1k5/FW/AmZ3su739vLQbcEEfn7UUK5cdRgcqEHA4SePhq5zQX$\n\
-5/FSILsStpu+9hZ6OGxVdLVWKOM5GZ8LCXw3cJCNbJvW1APCz+3bP3bGBANeCUJp$\n\
-gt0b83u4YBs1t66ZV/rcDQiyQzjAY6th2UfRggZxeIRDO7qbRa+M0pVW3qugMytf$\n\
-bPw02aMbgH96rX61u0sd1M0slJHFEeqquqbtPcU=$\n\
+hvcNAQELBQADggEBAITHC93SNagVrwUX41aUUJlIg6s+E8LXGZIP77HGSd48R1zS$\n\
++xPQcs2OKJaFESRZTJFgZ+wyPW3VhLm/ObYKbQiqmXc7W91nne+mywOF8cxcOoNw$\n\
+BDkVACyN36A6Bm42zTVdf0CYQR2d4pnI1LzWsGSQVRh+oCnrapxbmmI105rgJ3q5$\n\
+3RRcFPuKDdycqXgCCem8Zmg+Pq4XWZlbcCk1jts1TbFjUmr9G7lBV7cUu3XurbK9$\n\
+6xiRwFqPA/1qwLgyEXwUlsJ63D1GwRNa9N8ynfLvtE3bhE+oGk3xPL2sQN8HMYVw$\n\
+NKDIcX/Eu+lJjdcg3xu8Ym/V8P/s/frahpF4Q1A=$\n\
 -----END CERTIFICATE-----"
 
-!define BADSSL_SELFSIGNED_THUMBPRINT '8577cec7988ad89d72400f5933988221984e3009'
+!define BADSSL_SELFSIGNED_THUMBPRINT '6e3df5d84de941e0b4c3d5f0788b7e0bfc0d42bf'
 
 
 Var /global testCacertName
@@ -678,6 +701,38 @@ Section "Weak protocols"
 SectionEnd
 
 
+Section "Cookie jar"
+	SectionIn ${INSTTYPE_MOST}
+	DetailPrint '=====[ ${__SECTION__} ]==============================='
+
+	!define /redef LINK 'https://httpbun.com/cookies/set?cookie1=value1&cookie2=value2'
+	!define /redef FILE '$EXEDIR\_test_cookiejar_body'
+	!define /redef JAR  '$EXEDIR\_test_cookiejar.txt'
+
+    Delete "${JAR}"
+
+    DetailPrint 'NScurl::http "${LINK}" /COOKIEJAR "${JAR}"'
+    NScurl::http get "${LINK}" "${FILE}" /COOKIEJAR "${JAR}" /TAG "test" /END
+    Pop $0
+
+    ${If} ${FileExists} "${JAR}"
+        StrCpy $1 "OK"
+    ${Else}
+        StrCpy $1 "MISSING"
+    ${EndIf}
+
+    IntOp $g_testCount $g_testCount + 1
+    ${If} $0 == "OK"
+    ${AndIf} $1 == "OK"
+        DetailPrint "[ OK ] status:$0, jar:$1"
+    ${Else}
+        IntOp $g_testFails $g_testFails + 1
+        DetailPrint "----- FAIL ----- status:$0, jar:$1"
+    ${EndIf}
+
+    NScurl::cancel /TAG "test" /REMOVE
+SectionEnd
+
 SectionGroupEnd