WlxGetOption Documentation

This addin was contributed by Jiøí Kutálek.

Environment: Visual C++

GINA's WlxGetOption function is not well documented on MSDN. I need to write GINA using smartcards, so I wanted to get information about the smartcards inserted during logon. Simply said, I want to use WlxGetOption to get some information. But what parameters have the function? When you look into the MSDN, you'll see something like:

BOOL WlxGetOption( HANDLE hWlx, DWORD Option, ULONG_PTR* Value);

where hWlx is the Winlogon handle. Option is one of these:

  • WLX_OPTION_USE_CTRL_ALT_DEL
  • WLX_OPTION_CONTEXT_POINTER
  • WLX_OPTION_USE_SMART_CARD
  • WLX_OPTION_SMART_CARD_PRESENT
  • WLX_OPTION_SMART_CARD_INFO
  • WLX_OPTION_DISPATCH_TABLE_SIZE

Value = current value of the option

I don't think "current value of the option" is the exact definition. There are six options; does each option has the same type of current value? After experimenting, I found the the sense of the "Value" parameter:

The "Value" type always points to DWORD.

  1. When one of these {WLX_OPTION_USE_CTRL_ALT_DEL, WLX_OPTION_USE_SMART_CARD, WLX_OPTION_SMART_CARD_PRESENT} options is used, the return value is BOOLEAN:
      DWORD dwX = 0;
      g_pWlxFuncs->WlxGetOption( g_hWlx,
                                 WLX_OPTION_USE_SMART_CARD,
                                 &dwX))
      if (dwX)
      {
        ASSERT(dwX==1);
        LOG("User can log on using smartcard");
      }
      else
      {
        ASSERT(dwX==0);
        LOG("User cannot use smartcard");
      }
    
    I found no differences between these options {WLX_OPTION_USE_SMART_CARD, WLX_OPTION_SMART_CARD_PRESENT}. It always returns the same values. Option WLX_OPTION_USE_CTRL_ALT_DEL always returns TRUE(?).

  2. When the WLX_OPTION_CONTEXT_POINTER option is used, the return value is a pointer to the GINA context. (This context pointer is the value often used as an input parameter for GINA's function, such as WlxDisplaySASNotice, WlxLoggedOutSAS, and so forth...)

  3. When the WLX_OPTION_SMART_CARD_INFO option is used, the return value is a pointer to the WLX_SC_NOTIFICATION_INFO structure. This structure is defined in the newer version of WinWlx.h as:
      typedef struct _WLX_SC_NOTIFICATION_INFO {
        PWSTR   pszCard ;
        PWSTR   pszReader ;
        PWSTR   pszContainer ;
        PWSTR   pszCryptoProvider ;
      } WLX_SC_NOTIFICATION_INFO, * PWLX_SC_NOTIFICATION_INFO ;
    
    If the smartcard is not acceptable, the return value is NULL:
      dwX = 0;
      PWLX_SC_NOTIFICATION_INFO pInfo = NULL;
      g_pWlxFuncs->WlxGetOption( g_hWlx,
                                    WLX_OPTION_SMART_CARD_INFO,
                                    &dwX) 
      if (dwX==0) LOG("Smart card is not acceptable");
      else
      {
        pInfo = (PWLX_SC_NOTIFICATION_INFO)dwX;
        LOG_FORMAT1("Card = %ws",pInfo->pszCard);
        LOG_FORMAT1("Reader = %ws",pInfo->pszReader);
        LOG_FORMAT1("Container = %ws",pInfo->pszContainer);
        LOG_FORMAT1("CSP = %ws",pInfo->pszCryptoProvider);
      }
    
    The pszContainer value was allways NULL in my experiments(?).
    WlxGetOption ret
    
  4. When the WLX_OPTION_DISPATCH_TABLE_SIZE option is used, the return value is a dispatch table sized in bytes.

The code was tested on Windows 2000, and dispatch version WLX_VERSION_1_3. I hope this article will save time for someone who wants to use WlxGetOption and looks for documentation about it. If you have some other experiences or suggestions, please add your comment.



Comments

  • awGthH RK cB jio InMX xO

    Posted by SUhVPyoUki on 05/20/2013 06:10am

    buy tramadol online cod overnight tramadol online apotheke - tramadol experiences

    Reply
  • NULL returned for WLX_OPTION_SMART_CARD_INFO

    Posted by Legacy on 10/29/2003 12:00am

    Originally posted by: chan

    Hi,
    
    

    Your info was really helpful to proceed.

    When i called the WlxGetOption with WLX_OPTION_SMART_CARD_INFO parameter, the third parameter had value 0.You have mentioned that this means "Smart card is not acceptable".

    What could be the problem and any suggestions to re ctify this.

    My smart card is working fine with MSGINA cert logon.

    Thanks a lot,
    Chan

    Reply
  • WlxGetOption Documentation

    Posted by Legacy on 09/16/2003 12:00am

    Originally posted by: Milan Spalek

    Great - your comments are very helpful 4 me! DEKUJU!!!
    

    Reply
  • Problem with Smart Cards on WIn XP

    Posted by Legacy on 09/06/2003 12:00am

    Originally posted by: bfadi

    Hi
    I made an new GINA.dll that use smart card for windows logon.
    It worke fine on Win2K but in XP it did not work. I could not get the message SAS_SC_INSERT !

    I put the folowing : SetOption(USE_SC,1)... But it did not work also.
    I found on the web that some people say that if the XP is not domain joined it will not support Smart Card logon !

    Please do you have any solution ?
    Thanks

    Reply
  • Great!! Thanks

    Posted by Legacy on 08/06/2002 12:00am

    Originally posted by: Giuseppe Amato

    Thankyou for this article...

    I'm writing a Smartcard enabled GINA replacement (based on the Ginastub MSDN example).
    It's making me crazy, because everything is bad documented!(or not documented at all!)

    tanks again
    Giuseppe Amato

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • On-demand Event Event Date: June 23, 2015 Business transformation is not just important, it is vital to the success of all organizations in the 21st century marketplace. How IT approaches and executes the move from cost center to revenue contributor will not only transform the IT organization, it will change how companies retain competitive advantage and meet the requirements of internal and external customers. This shift in thinking is not new, but actualizing it is. Check out this eSeminar to learn the …

  • To help companies compete in this constantly changing business world, finance executives and their teams must be more responsive and focus on delivering greater value. Along with a unique, enterprise-wide business perspective, finance needs simple and agile solutions to solve the next decade's challenges and accommodate the shift to becoming a service organization within the company. This eBook outlines some of the challenges facing organizations like yours and discusses how the right financial management …

Most Popular Programming Stories

More for Developers

RSS Feeds

Thanks for your registration, follow us on our social networks to keep up-to-date