kio/kio/authinfo.cpp

   1 /*
   2  *  This file is part of the KDE libraries
   3  *  Copyright (C) 2000-2001 Dawit Alemayehu <adawit@kde.org>
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Library General Public
   7  *  License as published by the Free Software Foundation; either
   8  *  version 2 of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Library General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Library General Public License
  16  *  along with this library; see the file COPYING.LIB.  If not, write to
  17  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  *  Boston, MA 02110-1301, USA.
  19  */
  20
  21 #include "authinfo.h"
  22
  23 #include <config.h>
  24
  25 #include <sys/stat.h> // don't move it down the include order, it breaks compilation on MSVC
  26 #include <stdio.h>
  27 #include <fcntl.h>
  28 #include <unistd.h>
  29 #include <sys/types.h>
  30
  31 #include <QtCore/QByteArray>
  32 #include <QtCore/QDir>
  33 #include <QtCore/QFile>
  34 #include <kde_file.h>
  35
  36 #include <kdebug.h>
  37 #include <kstandarddirs.h>
  38 #include <ksavefile.h>
  39
  40 #define NETRC_READ_BUF_SIZE 4096
  41
  42 using namespace KIO;
  43
  44 //////
  45
  46 class ExtraField
  47 {
  48 public:
  49     QString customTitle; // reserved for future use
  50     AuthInfo::FieldFlags flags;
  51     QVariant value;
  52
  53     ExtraField() : flags(AuthInfo::ExtraFieldNoFlags) {}
  54 };
  55
  56 QDataStream& operator<< (QDataStream& s, const ExtraField& extraField)
  57 {
  58     s << extraField.customTitle;
  59     s << (int)extraField.flags;
  60     s << extraField.value;
  61     return s;
  62 }
  63
  64 QDataStream& operator>> (QDataStream& s, ExtraField& extraField)
  65 {
  66     s >> extraField.customTitle ;
  67     int i;
  68     s >> i;
  69     extraField.flags = (AuthInfo::FieldFlags)i;
  70     s >> extraField.value ;
  71     return s;
  72 }
  73
  74
  75 class KIO::AuthInfoPrivate
  76 {
  77 public:
  78     AuthInfoPrivate()
  79     {}
  80
  81     QMap<QString, ExtraField> extraFields;
  82 };
  83
  84
  85 //////
  86
  87 AuthInfo::AuthInfo() : d(new AuthInfoPrivate())
  88 {
  89     modified = false;
  90     readOnly = false;
  91     verifyPath = false;
  92     keepPassword = false;
  93 }
  94
  95 AuthInfo::AuthInfo( const AuthInfo& info ) : d(new AuthInfoPrivate())
  96 {
  97     (*this) = info;
  98 }
  99
 100 AuthInfo::~AuthInfo()
 101 {
 102     delete d;
 103 }
 104
 105 AuthInfo& AuthInfo::operator= ( const AuthInfo& info )
 106 {
 107     url = info.url;
 108     username = info.username;
 109     password = info.password;
 110     prompt = info.prompt;
 111     caption = info.caption;
 112     comment = info.comment;
 113     commentLabel = info.commentLabel;
 114     realmValue = info.realmValue;
 115     digestInfo = info.digestInfo;
 116     verifyPath = info.verifyPath;
 117     readOnly = info.readOnly;
 118     keepPassword = info.keepPassword;
 119     modified = info.modified;
 120     d->extraFields = info.d->extraFields;
 121     return *this;
 122 }
 123
 124 bool AuthInfo::isModified() const
 125 {
 126     return modified;
 127 }
 128
 129 void AuthInfo::setModified( bool flag )
 130 {
 131     modified = flag;
 132 }
 133
 134 /////
 135
 136 void AuthInfo::setExtraField(const QString &fieldName, const QVariant & value)
 137 {
 138     d->extraFields[fieldName].value = value;
 139 }
 140
 141 void AuthInfo::setExtraFieldFlags(const QString &fieldName, const FieldFlags flags)
 142 {
 143     d->extraFields[fieldName].flags = flags;
 144 }
 145
 146 QVariant AuthInfo::getExtraField(const QString &fieldName) const
 147 {
 148     if (!d->extraFields.contains(fieldName)) return QVariant();
 149     return d->extraFields[fieldName].value;
 150 }
 151
 152 AuthInfo::FieldFlags AuthInfo::getExtraFieldFlags(const QString &fieldName) const
 153 {
 154     if (!d->extraFields.contains(fieldName)) return AuthInfo::ExtraFieldNoFlags;
 155     return d->extraFields[fieldName].flags;
 156 }
 157
 158 /////
 159
 160 QDataStream& KIO::operator<< (QDataStream& s, const AuthInfo& a)
 161 {
 162     s << (quint8)1
 163       << a.url << a.username << a.password << a.prompt << a.caption
 164       << a.comment << a.commentLabel << a.realmValue << a.digestInfo
 165       << a.verifyPath << a.readOnly << a.keepPassword << a.modified
 166       << a.d->extraFields;
 167     return s;
 168 }
 169
 170 QDataStream& KIO::operator>> (QDataStream& s, AuthInfo& a)
 171 {
 172     quint8 version;
 173     s >> version
 174       >> a.url >> a.username >> a.password >> a.prompt >> a.caption
 175       >> a.comment >> a.commentLabel >> a.realmValue >> a.digestInfo
 176       >> a.verifyPath >> a.readOnly >> a.keepPassword >> a.modified
 177       >> a.d->extraFields;
 178     return s;
 179 }
 180
 181
 182 typedef QList<NetRC::AutoLogin> LoginList;
 183 typedef QMap<QString, LoginList> LoginMap;
 184
 185 class NetRC::NetRCPrivate
 186 {
 187 public:
 188     NetRCPrivate()
 189         : isDirty(false)
 190     {}
 191     bool isDirty;
 192     LoginMap loginMap;
 193 };
 194
 195 NetRC* NetRC::instance = 0L;
 196
 197 NetRC::NetRC()
 198     : d( new NetRCPrivate )
 199 {
 200 }
 201
 202 NetRC::~NetRC()
 203 {
 204     delete instance;
 205     instance = 0L;
 206     delete d;
 207 }
 208
 209 NetRC* NetRC::self()
 210 {
 211     if ( !instance )
 212         instance = new NetRC;
 213     return instance;
 214 }
 215
 216 bool NetRC::lookup( const KUrl& url, AutoLogin& login, bool userealnetrc,
 217                     const QString &_type, LookUpMode mode )
 218 {
 219   // kDebug() << "AutoLogin lookup for: " << url.host();
 220   if ( !url.isValid() )
 221     return false;
 222
 223   QString type = _type;
 224   if ( type.isEmpty() )
 225     type = url.protocol();
 226
 227   if ( d->loginMap.isEmpty() || d->isDirty )
 228   {
 229     d->loginMap.clear();
 230
 231     QString filename = KStandardDirs::locateLocal("config", QLatin1String("kionetrc"));
 232     bool status = parse (openf (filename));
 233
 234     if ( userealnetrc )
 235     {
 236       filename =  QDir::homePath() + QDir::separator() + QLatin1String(".netrc");
 237       status |= parse (openf(filename));
 238     }
 239
 240     if ( !status )
 241       return false;
 242   }
 243
 244   if ( !d->loginMap.contains( type ) )
 245     return false;
 246
 247   const LoginList& l = d->loginMap[type];
 248   if ( l.isEmpty() )
 249     return false;
 250
 251   for (LoginList::ConstIterator it = l.begin(); it != l.end(); ++it)
 252   {
 253     const AutoLogin &log = *it;
 254
 255     if ( (mode & defaultOnly) == defaultOnly &&
 256           log.machine == QLatin1String("default") &&
 257           (login.login.isEmpty() || login.login == log.login) )
 258     {
 259       login.type = log.type;
 260       login.machine = log.machine;
 261       login.login = log.login;
 262       login.password = log.password;
 263       login.macdef = log.macdef;
 264     }
 265
 266     if ( (mode & presetOnly) == presetOnly &&
 267           log.machine == QLatin1String("preset") &&
 268           (login.login.isEmpty() || login.login == log.login) )
 269     {
 270       login.type = log.type;
 271       login.machine = log.machine;
 272       login.login = log.login;
 273       login.password = log.password;
 274       login.macdef = log.macdef;
 275     }
 276
 277     if ( (mode & exactOnly) == exactOnly &&
 278           log.machine == url.host() &&
 279           (login.login.isEmpty() || login.login == log.login) )
 280     {
 281       login.type = log.type;
 282       login.machine = log.machine;
 283       login.login = log.login;
 284       login.password = log.password;
 285       login.macdef = log.macdef;
 286       break;
 287     }
 288   }
 289
 290   return true;
 291 }
 292
 293 void NetRC::reload()
 294 {
 295     d->isDirty = true;
 296 }
 297
 298 int NetRC::openf( const QString& f )
 299 {
 300   KDE_struct_stat sbuff;
 301   if ( KDE::stat(f, &sbuff) != 0 )
 302     return -1;
 303
 304   // Security check!!
 305   if ( sbuff.st_mode != (S_IFREG|S_IRUSR|S_IWUSR) ||
 306        sbuff.st_uid != geteuid() )
 307     return -1;
 308
 309   return KDE::open( f, O_RDONLY );
 310 }
 311
 312 QString NetRC::extract( const char* buf, const char* key, int& pos )
 313 {
 314   int idx = pos;
 315   int m_len = strlen(key);
 316   int b_len = strlen(buf);
 317
 318   while( idx < b_len )
 319   {
 320     while( buf[idx] == ' ' || buf[idx] == '\t' )
 321       idx++;
 322
 323     if ( strncasecmp( buf+idx, key, m_len ) != 0 )
 324       idx++;
 325     else
 326     {
 327       idx += m_len;
 328       while( buf[idx] == ' ' || buf[idx] == '\t' )
 329         idx++;
 330
 331       int start = idx;
 332       while( buf[idx] != ' ' && buf[idx] != '\t' &&
 333              buf[idx] != '\n' && buf[idx] != '\r' )
 334         idx++;
 335
 336       if ( idx > start )
 337       {
 338         pos = idx;
 339         return QString::fromLatin1( buf+start, idx-start);
 340       }
 341     }
 342   }
 343
 344   return QString();
 345 }
 346
 347 bool NetRC::parse( int fd )
 348 {
 349   if (fd == -1)
 350     return false;
 351
 352   QString type;
 353   QString macro;
 354
 355   uint index = 0;
 356   bool isMacro = false;
 357   char* buf = new char[NETRC_READ_BUF_SIZE];
 358   FILE* fstream = KDE_fdopen( fd,"rb" );
 359
 360   while ( fgets (buf, NETRC_READ_BUF_SIZE, fstream) != 0L )
 361   {
 362     int pos = 0;
 363
 364     while ( buf[pos] == ' ' || buf[pos] == '\t' )
 365       pos++;
 366
 367     if ( buf[pos] == '#' || buf[pos] == '\n' ||
 368          buf[pos] == '\r' || buf[pos] == '\0' )
 369     {
 370       if ( buf[pos] != '#' && isMacro )
 371         isMacro = false;
 372
 373       continue;
 374     }
 375
 376     if ( isMacro )
 377     {
 378       int tail = strlen(buf);
 379       while( buf[tail-1] == '\n' || buf[tail-1] =='\r' )
 380         tail--;
 381
 382       QString mac = QString::fromLatin1(buf, tail).trimmed();
 383       if ( !mac.isEmpty() )
 384         d->loginMap[type][index].macdef[macro].append( mac );
 385
 386       continue;
 387     }
 388
 389     AutoLogin l;
 390     l.machine = extract( buf, "machine", pos );
 391     if ( l.machine.isEmpty() )
 392     {
 393       if (strncasecmp(buf+pos, "default", 7) == 0 )
 394       {
 395         pos += 7;
 396         l.machine = QLatin1String("default");
 397       }
 398       else if (strncasecmp(buf+pos, "preset", 6) == 0 )
 399       {
 400         pos += 6;
 401         l.machine = QLatin1String("preset");
 402       }
 403     }
 404     // kDebug() << "Machine: " << l.machine;
 405
 406     l.login = extract( buf, "login", pos );
 407     // kDebug() << "Login: " << l.login;
 408
 409     l.password = extract( buf, "password", pos );
 410     if ( l.password.isEmpty() )
 411       l.password = extract( buf, "account", pos );
 412     // kDebug() << "Password: " << l.password;
 413
 414     type = l.type = extract( buf, "type", pos );
 415     if ( l.type.isEmpty() && !l.machine.isEmpty() )
 416       type = l.type = QLatin1String("ftp");
 417     // kDebug() << "Type: " << l.type;
 418
 419     macro = extract( buf, "macdef", pos );
 420     isMacro = !macro.isEmpty();
 421     // kDebug() << "Macro: " << macro;
 422
 423     d->loginMap[l.type].append(l);
 424     index = d->loginMap[l.type].count()-1;
 425   }
 426
 427   delete [] buf;
 428   fclose (fstream);
 429   close (fd);
 430   return true;
 431 }