auth.h (2064B)
1/* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 20#ifndef GUAC_VNC_AUTH_H 21#define GUAC_VNC_AUTH_H 22 23#include "config.h" 24 25#include <rfb/rfbclient.h> 26#include <rfb/rfbproto.h> 27 28/** 29 * Callback which is invoked by libVNCServer when it needs to read the user's 30 * VNC password. As this user's password, if any, will be stored in the 31 * connection settings, this function does nothing more than return that value. 32 * 33 * @param client 34 * The rfbClient associated with the VNC connection requiring the password. 35 * 36 * @return 37 * The password to provide to the VNC server. 38 */ 39char* guac_vnc_get_password(rfbClient* client); 40 41#ifdef ENABLE_VNC_GENERIC_CREDENTIALS 42/** 43 * Callback which is invoked by libVNCServer when it needs to read the user's 44 * VNC credentials. The credentials are stored in the connection settings, 45 * so they will be retrieved from that. 46 * 47 * @param client 48 * The rfbClient associated with the VNC connection requiring the 49 * authentication. 50 * 51 * @param credentialType 52 * The credential type being requested, as defined by the libVNCclient 53 * code in the rfbclient.h header. 54 * 55 * @return 56 * The rfbCredential object that contains the required credentials. 57 */ 58rfbCredential* guac_vnc_get_credentials(rfbClient* client, int credentialType); 59#endif 60 61#endif 62