Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

SQL Server Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(SQL Server) SFTP Auth Failure Reason (AuthenticatePwPk)

This example demonstrates how to determine the failure reason for the case where both a password and private key are required for authentication. If authentication fails, was it because of an invalid private key, or an invalid password?

Note: This example requires a feature introduced in Chilkat v9.5.0.79

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

// Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
//
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- Load a private key to be used for SSH authentication.
    DECLARE @key int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SshKey', @key OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @key, 'Password', 'key_password'

    DECLARE @success int
    EXEC sp_OAMethod @key, 'LoadText', @sTmp0 OUT, 'qa_data/my_private_key_file'
    EXEC sp_OAMethod @key, 'FromOpenSshPrivateKey', @success OUT, @sTmp0
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @key, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @key
        RETURN
      END

    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.SFtp', @sftp OUT

    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'sftp.example.com', 22
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @key
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Authenticate using both a password and private key.
    EXEC sp_OAMethod @sftp, 'AuthenticatePwPk', @success OUT, 'myLogin', 'myPassword', @key
    IF @success = 1
      BEGIN

        PRINT 'Authentication is successful!'
        EXEC @hr = sp_OADestroy @key
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- If we get here, it means the authentication failed.
    -- To find out why, get the LastJsonData
    -- This is a feature added in Chilkat v9.5.0.79

    DECLARE @json int
    EXEC sp_OAMethod @sftp, 'LastJsonData', @json OUT
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    -- This is the JSON if the key is correct, but the password is incorrect:

    -- {
    --   "public_key_type": "rsa",
    --   "partialAuthResult": "publickey success. continue to authenticate with password...",
    --   "authResult": "failed",
    --   "authFailReason": "Password is incorrect"
    -- }

    -- This is the JSON if the key is incorrect.  We won't know if the password is also incorrect until
    -- the key is made correct so that authentication proceeds to check the password.

    -- {
    --   "public_key_type": "rsa",
    --   "authResult": "failed",
    --   "authFailReason": "Key is incorrect"
    -- }

    -- To get the authResult anbd authFailReason:

    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'authResult'
    PRINT 'authResult: ' + @sTmp0

    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'authFailReason'
    PRINT 'authFailReason: ' + @sTmp0

    EXEC @hr = sp_OADestroy @json


    EXEC @hr = sp_OADestroy @key
    EXEC @hr = sp_OADestroy @sftp


END
GO

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.