phish.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 Meni Livne <livne@kde.org>                         *
 *   Copyright (C) 2005 Boaz Anin <boazanin@gmail.com>                     *
 *   Copyright (C) 2005 Shahar Karin <shaharka@post.tau.ac.il>             *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef __PHISH_H
#define __PHISH_H


#ifdef __cplusplus
extern "C" {
#endif


#define PHISH_LIB_NAME "libphish"
#define PHISH_LIB_VERSION "0.1.0"


#include <sys/types.h>

#define PHISH_SUCCESS 0

#define PHISH_ERR_NOT_INITIALISED 1

#define PHISH_ERR_MEMORY 2

#define PHISH_ERR_SETTINGS 3

#define PHISH_ERR_MALFORMED_URL 11

#define PHISH_ERR_TCP_CONNECT 21

#define PHISH_ERR_SOCK_READ 22

#define PHISH_ERR_SOCK_WRITE 23

#define PHISH_ERR_RESOLVE 24

#define PHISH_ERR_HTTP_BAD_HEADER 25

#define PHISH_ERR_HTTP_BAD_STATUS 26

#define PHISH_ERR_FILE 31

#define PHISH_ERR_FILE_WRITE 32

#define PHISH_XML_READ_ERROR 41

#define PHISH_XML_PARSE_ERROR 42

#define PHISH_ERR_OPDB_BAD_REPLY 51

#define PHISH_XML_NOT_MODIFIED 61


#define PHISH_URL_LENGTH_LIMIT 4192


typedef int phish_result_t;

typedef enum { PHISH_ONLINE_MODE, PHISH_OFFLINE_MODE } phish_mode_t;

typedef enum { PHISH_RISK_UNKNOWN, PHISH_RISK_NONE,
               PHISH_RISK_LOW, PHISH_RISK_MEDIUM,
               PHISH_RISK_HIGH } phish_risk_t;

typedef struct
{
  phish_risk_t risk_level;

  int server;

  int ip;

  int path;

  int domain;

  char country[3];

  size_t comments_length;

  char *comments;

  int user_scheme;

  int suspicious_host;
  
} phish_url_data_t;


typedef struct phish_safelist_t phish_safe_list_t;

typedef struct phish_safelist_entry_t phish_safe_list_entry_t;


phish_result_t phish_init(const char *user_agent,
                          const char *client_version);

phish_result_t phish_shutdown();

phish_result_t phish_checkURL(const char *url, phish_url_data_t *results);

phish_result_t phish_checkCountry(const char *url, phish_url_data_t *results);

phish_result_t phish_deleteURLData(phish_url_data_t *url_data);

phish_result_t phish_checkSafeList(const char *url, int *reply);

phish_result_t phish_downloadDBAsXML();

phish_result_t phish_getReportingURL(const char *url, char **result);

phish_result_t phish_getSafeListFirst(phish_safe_list_entry_t **entry);

phish_result_t phish_getSafeListNext(phish_safe_list_entry_t *entry,
                                     phish_safe_list_entry_t **next);

phish_result_t phish_getSafeListData(phish_safe_list_entry_t *entry,
                                     const char **url);

phish_result_t phish_addToCurrentSafeList(const char *url);

phish_result_t phish_newSafeList(phish_safe_list_t **list);

phish_result_t phish_addToSafeList(phish_safe_list_t *list, const char *url);

phish_result_t phish_setSafeList(phish_safe_list_t *list);

phish_result_t phish_saveSafeList();

phish_result_t phish_saveSettings();


phish_result_t phish_runningMode(phish_mode_t *result);

phish_result_t phish_siteQueryURL(const char **result);

phish_result_t phish_countryQueryURL(const char **result);

phish_result_t phish_reportSiteURL(const char **result);

phish_result_t phish_remoteXMLURL(const char **result);

phish_result_t phish_localXMLFile(const char **result);

phish_result_t phish_safeListFile(const char **result);

phish_result_t phish_setRunningMode(phish_mode_t mode);

phish_result_t phish_setSiteQueryURL(const char *url);

phish_result_t phish_setCountryQueryURL(const char *url);

phish_result_t phish_setReportSiteURL(const char *url);

phish_result_t phish_setRemoteXMLURL(const char *url);

phish_result_t phish_setLocalXMLFile(const char *path);

phish_result_t phish_setSafeListFile(const char *path);


#ifdef __cplusplus
}
#endif

#endif /* __PHISH_H */

---