git.sesse.net Git - vlc/blob - include/vlc_update.h

   1 /*****************************************************************************
   2  * vlc_update.h: VLC update and plugins download
   3  *****************************************************************************
   4  * Copyright © 2005-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea -at- videolan -dot- org>
   8  *          Rafaël Carré <funman@videolanorg>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either release 2 of the License, or
  13  * (at your option) any later release.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 #ifdef UPDATE_CHECK
  30
  31 #ifndef _VLC_UPDATE_H
  32 #define _VLC_UPDATE_H
  33
  34 #include <vlc/vlc.h>
  35
  36 #include <vlc_stream.h>     /* key & signature downloading */
  37 #include <vlc_strings.h>    /* b64 decoding */
  38 #include <vlc_charset.h>    /* utf8_fopen() */
  39 #include <gcrypt.h>         /* cryptography and digest algorithms */
  40
  41 /**
  42  * \defgroup update Update
  43  *
  44  * @{
  45  */
  46
  47 enum    /* Public key algorithms */
  48 {
  49     /* we will only use DSA public keys */
  50     PUBLIC_KEY_ALGO_DSA = 0x11
  51 };
  52
  53 enum    /* Digest algorithms */
  54 {
  55     /* and DSA use SHA-1 digest */
  56     DIGEST_ALGO_SHA1    = 0x02
  57 };
  58
  59 enum    /* Packet types */
  60 {
  61     SIGNATURE_PACKET    = 0x02,
  62     PUBLIC_KEY_PACKET   = 0x06,
  63     USER_ID_PACKET      = 0x0d
  64 };
  65
  66 enum    /* Signature types */
  67 {
  68     BINARY_SIGNATURE        = 0x00,
  69     TEXT_SIGNATURE          = 0x01,
  70
  71     /* Public keys signatures */
  72     GENERIC_KEY_SIGNATURE   = 0x10, /* No assumption of verification */
  73     PERSONA_KEY_SIGNATURE   = 0x11, /* No verification has been made */
  74     CASUAL_KEY_SIGNATURE    = 0x12, /* Some casual verification */
  75     POSITIVE_KEY_SIGNATURE  = 0x13  /* Substantial verification */
  76 };
  77
  78
  79 enum    /* Signature subpacket types */
  80 {
  81     ISSUER_SUBPACKET    = 0x10
  82 };
  83
  84
  85
  86 struct public_key_packet_t
  87 { /* a public key packet (DSA/SHA-1) is 418 bytes */
  88
  89     uint8_t version;      /* we use only version 4 */
  90     uint8_t timestamp[4]; /* creation time of the key */
  91     uint8_t algo;         /* we only use DSA */
  92     /* the multi precision integers, with their 2 bytes length header */
  93     uint8_t p[2+128];
  94     uint8_t q[2+20];
  95     uint8_t g[2+128];
  96     uint8_t y[2+128];
  97 };
  98
  99 /* used for public key signatures */
 100 struct signature_packet_v4_t
 101 { /* hashed_data or unhashed_data can be empty, so the signature packet is
 102    * theorically at least 54 bytes long, but always more than that. */
 103
 104     uint8_t version;
 105     uint8_t type;
 106     uint8_t public_key_algo;
 107     uint8_t digest_algo;
 108     uint8_t hashed_data_len[2];
 109     uint8_t *hashed_data;
 110     uint8_t unhashed_data_len[2];
 111     uint8_t *unhashed_data;
 112     uint8_t hash_verification[2];
 113
 114     /* The part below is made of consecutive MPIs, their number and size being
 115      * public-key-algorithm dependant.
 116      * But since we use DSA signatures only, we fix it. */
 117     uint8_t r[2+20];
 118     uint8_t s[2+20];
 119 };
 120
 121 /* Used for binary document signatures (to be compatible with older software)
 122  * DSA/SHA-1 is always 65 bytes */
 123 struct signature_packet_v3_t
 124 {
 125     uint8_t header[2];
 126     uint8_t version;            /* 3 */
 127     uint8_t hashed_data_len;    /* MUST be 5 */
 128     uint8_t type;
 129     uint8_t timestamp[4];       /* 4 bytes scalar number */
 130     uint8_t issuer_longid[8];  /* The key which signed the document */
 131     uint8_t public_key_algo;    /* we only know about DSA */
 132     uint8_t digest_algo;        /* and his little sister SHA-1 */
 133     uint8_t hash_verification[2];/* the 2 1st bytes of the SHA-1 hash */
 134
 135     /* The part below is made of consecutive MPIs, their number and size being
 136      * public-key-algorithm dependant.
 137      * But since we use DSA signatures only, we fix it. */
 138     uint8_t r[2+20];
 139     uint8_t s[2+20];
 140 };
 141
 142 typedef struct public_key_packet_t public_key_packet_t;
 143 typedef struct signature_packet_v4_t signature_packet_v4_t;
 144 typedef struct signature_packet_v3_t signature_packet_v3_t;
 145
 146 struct public_key_t
 147 {
 148     uint8_t longid[8];       /* Long id */
 149     uint8_t *psz_username;    /* USER ID */
 150
 151     public_key_packet_t key;       /* Public key packet */
 152
 153     signature_packet_v4_t sig;     /* Signature packet, by the embedded key */
 154 };
 155
 156 typedef struct public_key_t public_key_t;
 157
 158 /* We trust this public key, and by extension, also keys signed by it. */
 159
 160 //#define OLD 1 //Define OLD to use Videolan Key 2006, to test public key download
 161
 162 static uint8_t videolan_public_key_longid[8] = {
 163 #ifdef OLD
 164   0xC3, 0x67, 0xD8, 0xB9, 0x81, 0xCA, 0xCA, 0x84
 165 #else
 166   0x90, 0x28, 0x17, 0xE4, 0xAA, 0x5F, 0x4D, 0xE6
 167 #endif
 168 };
 169
 170 static uint8_t videolan_public_key[] = {
 171 #ifdef OLD
 172 "-----BEGIN PGP PUBLIC KEY BLOCK-----\n"
 173 "Version: GnuPG v2.0.4 (FreeBSD)\n"
 174 "\n"
 175 "mQGiBEPBV9IRBADqm3i6AnMyZ2/iowBPZJrP3bwhcqx9EhJR5/N8Pz+QjhvLsY5P\n"
 176 "efH1381RlEk33dl0vEvKULFstqT2GO+vtdoE+35tf1YlYFvxy23qn3Gsn2IMM6pl\n"
 177 "e0AatBnxzD1Vtlh7+Xhm0PvGJilZeg/MamEK2A8hgwhj3aGxVfzdtkQ1HwCg9XIo\n"
 178 "PZ8x5W0r6sfRXYmCDR06NFEEANRY98cFWJdvBmutLzoSC9y7eLxyGzKofs7ikxKg\n"
 179 "myT1o3eraeCoZc+mIbZG4cZA9UqL/fmqZa/3gvnvDEzoI8u7u7gL6bu499XAnzVd\n"
 180 "VV4cwvzgAPnMiqhi0jNWlXbt4dyZ+sWDhkL+ivrg3HsRU9xQUvYv54YQT0FxmR+E\n"
 181 "yTnjA/9KoPRPwAWy7Q4R24CNSjMz5+075J2LUz0QDjTzcLh6Y/gI7oxNGsgsmLQ8\n"
 182 "LMgtPZPbNw1FP6c6LMdUsLBCuCBKr7K3qOMubZc4694kB28bnpvP9EiHqvF8XiuY\n"
 183 "lNNHzqFVCufAuSceg4B+INczF46i0KUT0xhsIkw0KMfofac+g7Q9VmlkZW9MQU4g\n"
 184 "QXV0b21hdGljIFNpZ25pbmcgS2V5ICgyMDA2KSA8dmlkZW9sYW5AdmlkZW9sYW4u\n"
 185 "b3JnPohGBBARAgAGBQJDwVhJAAoJEK0m7YKmyAW5enUAoKomp97VmvhcxzFFAWVq\n"
 186 "nVmgR5o1AJ9pDxHnR987+WpQJEb29fOGRCv9mIhGBBARAgAGBQJDwvoRAAoJEKe9\n"
 187 "h1GAZnhb3x0AnjPZNWxOxcgCm3pYNqvvoEG4Yn6lAKC25Llg8SZZ2ClPNK5a43Lm\n"
 188 "QSLm8ohGBBMRAgAGBQJDwqW1AAoJEMPsbb7dbRK9zUIAoMxt11NpDs2I6PWn5rs3\n"
 189 "kv2ERS/jAJ4lzBh03apWuHGRVTpa7JUwcuRrTIhGBBMRAgAGBQJDwveAAAoJEDlN\n"
 190 "xZEO1wTqjN8Ani62eTBkOmn48PiGgDxlv0HDKGY+AKCT8dJrDIvWRbioeVoZ2q32\n"
 191 "ro6nBohGBBMRAgAGBQJECI5aAAoJEMcpqsa+jGsuS4AAnRF5BHE4I5+x6LxpXwqI\n"
 192 "rJYaJlr6AKCDpSflz+eOARGyMVNZ+tfN7zuYP4hJBBARAgAJBQJEiFlSAgcAAAoJ\n"
 193 "EJ7/Di3F33VbbR8An2SLqQLhyCrSivMvhkY5y09u/JVyAJ9jLnR/JR/tP0bsaKSz\n"
 194 "+unF3Tb7YohlBBMRAgAmBQJDwVfSAhsDBQkB3+IABgsJCAcDAgQVAggDBBYCAwEC\n"
 195 "HgECF4AACgkQw2fYuYHKyoSRdACfcNQ3qoDA0PXABrljF5CctywanhoAmMZ9tbyn\n"
 196 "LFy4ELbzCCglS8aJrYS5Ag0EQ8FX4xAIAICyMekh4upMZcq/x3krQAQ8bVTzOd1h\n"
 197 "tcI4UV2voBEapdA7DA/xRpEjNO05o1LM/oq9Rzh8oQtEWf75vNeOLJfiVR1Vy3cz\n"
 198 "0+a45GR4xFSTHg9zl13OM/oLI5hXrp5O5Zwu6yIZqBRiQNoCifKNvM3nrPhkjszr\n"
 199 "TNMx2gH84DkoTDGh7th4Iar/t05Q9Ni3HS86LHOAJS4aEimPl/zqM3NyJnZDtlu1\n"
 200 "dQ0DT13ykHmofrEb4cLNBwER2KfhmR/o9f/ybpPwpUaL3Wo1jJYYEQscBHH0o1Rl\n"
 201 "OvLKwZrrkwEAuIJRGMWYYtFSecqr/kuSHKc5XQtx/mUnOy+Nrt7ooPcAAwUH+wWM\n"
 202 "Ce3G4L4dASjTeZlmd8ETUV5Y7iP9GUJrGHek1S5JJeiMKqjfoMVsshBTJlZPkUYq\n"
 203 "OwnJZzI5lxGD9SbkE2n9LUWGXll3GDbV0zXdzaG5/Efzq5BpISkpqyDszDxb9LPi\n"
 204 "XQD/EiYP9pqlivgCTIqtcxN0Pdr0ArW0q7/yBfqWe0Fw9JrxHFN8dzmBnZk/sUis\n"
 205 "ZIxcRWlK/mdfxgcbRSKsaqucToubwJvIONaW3y/zURjG/Ehdkh/NR7yEnMJN6/SY\n"
 206 "E8VgjwL9Wx1KfC8nuqkFhmSMoIVKOck+0lAU3iTpThyYlU0M1luJvkYT2+Enlc1P\n"
 207 "eqMK0FlDmF60NbnPuzOITwQYEQIADwUCQ8FX4wIbDAUJAd/iAAAKCRDDZ9i5gcrK\n"
 208 "hCMLAKDB2xwcJT9OFM6G/seEnVMWGBfzrACg8UyCfxX2mNWNPTE4MQ/xiaQ6VBM=\n"
 209 "=tVe2\n"
 210 "-----END PGP PUBLIC KEY BLOCK-----\n"
 211 #else
 212 "-----BEGIN PGP PUBLIC KEY BLOCK-----\n"
 213 "Version: GnuPG v2.0.4 (FreeBSD)\n"
 214 "\n"
 215 "mQGiBEWbjf8RBAC+4m2yYYzuA0+D5JQatKmoxG4z3+bat08tMz0YvBUp1UU+95i4\n"
 216 "cP9ndklv3yzhtZ4MIx5yy64FXtPi0/NQiikEVYPYn2KMO4LCfZCwYBEizVWzABya\n"
 217 "LZcffCP/3VhoR90NUluWyi+zVAn9KNIRlnhnYpDDlI76fCrTTHDCtgpImwCg7VzB\n"
 218 "4L6O0JpUJBCZOCAPJNYirUkD/3uCZe4vK4kLW+W3HB+grMCI1uFULmVSKMBQZc+p\n"
 219 "dqDq++u3zYGqiMNaVrLg/J4GSH/P0ossXEtmTVjLHF4nJ7HXfIjqkqdkxq7g9odY\n"
 220 "/dkA/aC7z4JBgcYfRnDMqfL12C+3b+KSwxQSzPcbvsFYm2KTgteLwG3mRlpL7Dh5\n"
 221 "S70nBAC1PkIl7mP4OL7vpQk9dkdQCARJLgyn5pu/pZV7He4fDLHkUr/atnYaIHk1\n"
 222 "15xl/ziHcBql2WmF0Uff9SuuNOi/hFCuWZSwPKsgtIhYZ5ut4FrBAVkqHV2CgxFp\n"
 223 "aSiA7+FTG91++LDsg2xrHyTRW+fQnPdpf5a4H1fF15azo40h17QjVmlkZW9MQU4g\n"
 224 "UmVsZWFzZSBTaWduaW5nIEtleSAoMjAwNymIRgQQEQIABgUCRZ41PgAKCRDDZ9i5\n"
 225 "gcrKhPmUAJ49Krgt6ZPZZ2YkW7fWFwTvSgGongCePDjnFh1g4078f7lycT4wFk/c\n"
 226 "vPiIRgQQEQIABgUCRZ71NQAKCRD9Ibw7rD4IebztAKCxuyWCjF2JPAe1hdZqNNbE\n"
 227 "/gWDRACfaBw6mpHh3+jZuNnRk6NctFMbTzWIRgQTEQIABgUCRZuOiQAKCRDD7G2+\n"
 228 "3W0SvRkEAJ9cCPrbfzoTHKUVlGLAKbx5pcoutQCdENlo4nwXbQHaREDqm+ISBU3p\n"
 229 "iXeIZgQTEQIAJgUCRZuN/wIbAwUJAeEzgAYLCQgHAwIEFQIIAwQWAgMBAh4BAheA\n"
 230 "AAoJEJAoF+SqX03m4ZQAoOSj3JzzUuY+n/oS0Y4/yZ4tThNNAJ4h+9FacWApQdNJ\n"
 231 "+PcydRFEEm203LkCDQRFm44DEAgAlNLlnyIkLJ/Uyncsd5nB46LqQpJDLJ3AalfN\n"
 232 "44Vy3aOG+aA7JsNL5T5r5WRGnAf41qSOFiuZHwjfrtKb4TWkcfWlpsi8t5uasII9\n"
 233 "WAVX2aVIbiPMNWUnhQIn8rjCRLm2t/0Hch0HDbXaI/hvub5qhmSHfmqzlkuEUyVu\n"
 234 "H+beivX8pQwxqpcWXrmwuNzhISR1DsWBn5u0WcOSqUDtFG5Me8AuPFR1oxdYTtvC\n"
 235 "vqlVnw6ag3QuNqaAgWDU5Ug/U10ZxCZTn5TAcp+1ZDlM/dXIwh8wKXDjiKqHgYg1\n"
 236 "VLQ4fOsscTJoUDOaobeaVwTcDaSB4yQ3bhB2q5fLKqj+bNrY9wADBQf/Rw92M9b/\n"
 237 "JRs5IpX3fcrgHetVLHPiRuW8btD6EkmlgyRFOwOCzOSlSzFW6DKFrbOvd01EWkaP\n"
 238 "4PWJNW7b7OZqzK+UWzlWTgtV/2iUJtHg3+euZRdc5V9gqW17+HIAxjJVE53Syn8u\n"
 239 "kiJpk7HebtQo/v/pk3jtxdeJU3fY8ZAKJFl8V9aAj7ATFaAhYohzyKTRYc04F0n6\n"
 240 "VJDtwQkobdhq2//+5hSVrJ9wXRRF6XFVxc32NinqDEYrJUvTVayYu28Ivg4CTlts\n"
 241 "a+R7x92aDVT2KT+voPIGZxPYjALGa/I2hrlEYD9CiRFNBKAzRiNGAOo67SNI4hDu\n"
 242 "rFWRmMNOONWpIIhPBBgRAgAPBQJFm44DAhsMBQkB4TOAAAoJEJAoF+SqX03m57kA\n"
 243 "oMPb2o2D9gSwQFKXhamx2YdrykHOAKDqQ1tHH3ULY5cLLAKVaQtsNhVEtQ==\n"
 244 "=qrc1\n"
 245 "-----END PGP PUBLIC KEY BLOCK-----\n"
 246 #endif
 247 };
 248
 249 enum
 250 {
 251     UpdateReleaseStatusOlder,
 252     UpdateReleaseStatusEqual,
 253     UpdateReleaseStatusNewer
 254 };
 255
 256 /**
 257  * Describes an update VLC release number
 258  */
 259 struct update_release_t
 260 {
 261     int i_major;        ///< Version major
 262     int i_minor;        ///< Version minor
 263     int i_revision;     ///< Version revision
 264     char* psz_svnrev;   ///< SVN revision
 265     char* psz_extra;    ///< Version extra
 266     char* psz_url;      ///< Download URL
 267     char* psz_desc;     ///< Release description
 268 };
 269
 270 /**
 271  * The update object. Stores (and caches) all information relative to updates
 272  */
 273 struct update_t
 274 {
 275     libvlc_int_t *p_libvlc;
 276     vlc_mutex_t lock;
 277     struct update_release_t release;    ///< Release (version)
 278 };
 279
 280 #define update_New( a ) __update_New( VLC_OBJECT( a ) )
 281
 282 VLC_EXPORT( update_t *, __update_New, ( vlc_object_t * ) );
 283 VLC_EXPORT( void, update_Delete, ( update_t * ) );
 284 VLC_EXPORT( void, update_Check, ( update_t * ) );
 285 VLC_EXPORT( int, update_CompareReleaseToCurrent, ( update_t * ) );
 286
 287 /**
 288  * @}
 289  */
 290
 291 #endif
 292
 293 #endif