From 4ad0dad3d9573d1e53d39d16753030a042cb0dfe Mon Sep 17 00:00:00 2001 From: Moxie Marlinspike Date: Sun, 8 Dec 2013 23:11:09 -0800 Subject: [PATCH] Squashed History --- .gitignore | 9 + .../jre/lib/security/US_export_policy.jar | Bin 0 -> 2487 bytes .../jre/lib/security/local_policy.jar | Bin 0 -> 2500 bytes Procfile | 2 + README.md | 49 + assembly.xml | 25 + config/sample.yml | 94 + pom.xml | 208 ++ protobuf/Makefile | 3 + protobuf/OutgoingMessageSignal.proto | 29 + .../WhisperServerConfiguration.java | 129 + .../textsecuregcm/WhisperServerService.java | 140 ++ .../auth/AccountAuthenticator.java | 68 + .../auth/AuthenticationCredentials.java | 76 + .../auth/AuthorizationHeader.java | 73 + .../auth/FederatedPeerAuthenticator.java | 74 + .../InvalidAuthorizationHeaderException.java | 28 + .../auth/MultiBasicAuthProvider.java | 69 + .../configuration/ApnConfiguration.java | 40 + .../FederationConfiguration.java | 68 + .../configuration/GcmConfiguration.java | 31 + .../configuration/GraphiteConfiguration.java | 39 + .../configuration/MemcacheConfiguration.java | 46 + .../configuration/NexmoConfiguration.java | 43 + .../RateLimitsConfiguration.java | 94 + .../configuration/RedisConfiguration.java | 33 + .../configuration/S3Configuration.java | 47 + .../configuration/TwilioConfiguration.java | 47 + .../controllers/AccountController.java | 195 ++ .../controllers/AttachmentController.java | 113 + .../controllers/DirectoryController.java | 105 + .../controllers/FederationController.java | 157 ++ .../controllers/KeysController.java | 92 + .../controllers/MessageController.java | 313 +++ .../controllers/NoSuchUserException.java | 45 + .../RateLimitExceededException.java | 23 + .../controllers/ValidationException.java | 21 + .../entities/AccountAttributes.java | 46 + .../textsecuregcm/entities/AccountCount.java | 35 + .../entities/ApnRegistrationId.java | 31 + .../entities/AttachmentDescriptor.java | 43 + .../textsecuregcm/entities/AttachmentUri.java | 39 + .../textsecuregcm/entities/ClientContact.java | 98 + .../entities/ClientContactTokens.java | 33 + .../entities/ClientContacts.java | 41 + .../entities/EncryptedOutgoingMessage.java | 115 + .../entities/GcmRegistrationId.java | 33 + .../entities/IncomingMessage.java | 56 + .../entities/IncomingMessageList.java | 37 + .../textsecuregcm/entities/MessageProtos.java | 809 +++++++ .../entities/MessageResponse.java | 40 + .../textsecuregcm/entities/PreKey.java | 116 + .../textsecuregcm/entities/PreKeyList.java | 44 + .../textsecuregcm/entities/RelayMessage.java | 55 + .../federation/FederatedClient.java | 212 ++ .../federation/FederatedClientManager.java | 62 + .../federation/FederatedPeer.java | 66 + .../federation/NoSuchPeerException.java | 24 + .../textsecuregcm/limits/LeakyBucket.java | 53 + .../textsecuregcm/limits/RateLimiter.java | 78 + .../textsecuregcm/limits/RateLimiters.java | 92 + .../mappers/IOExceptionMapper.java | 37 + .../RateLimitExceededExceptionMapper.java | 31 + .../providers/MemcacheHealthCheck.java | 53 + .../providers/MemcachedClientFactory.java | 54 + .../providers/RedisClientFactory.java | 54 + .../providers/RedisHealthCheck.java | 49 + .../textsecuregcm/push/APNSender.java | 116 + .../textsecuregcm/push/GCMSender.java | 63 + .../textsecuregcm/push/PushSender.java | 103 + .../textsecuregcm/sms/NexmoSmsSender.java | 92 + .../textsecuregcm/sms/SenderFactory.java | 70 + .../textsecuregcm/sms/TwilioSmsSender.java | 81 + .../textsecuregcm/storage/Account.java | 109 + .../textsecuregcm/storage/Accounts.java | 133 ++ .../storage/AccountsManager.java | 108 + .../storage/DirectoryManager.java | 164 ++ .../textsecuregcm/storage/Keys.java | 121 + .../storage/PendingAccounts.java | 32 + .../storage/PendingAccountsManager.java | 62 + .../textsecuregcm/util/Base64.java | 2096 +++++++++++++++++ .../textsecuregcm/util/ByteArrayAdapter.java | 50 + .../textsecuregcm/util/Conversions.java | 180 ++ .../textsecuregcm/util/Hex.java | 109 + .../textsecuregcm/util/IterablePair.java | 77 + .../textsecuregcm/util/UrlSigner.java | 52 + .../textsecuregcm/util/Util.java | 86 + .../textsecuregcm/util/VerificationCode.java | 57 + .../workers/DirectoryCommand.java | 76 + .../workers/DirectoryUpdater.java | 126 + src/main/resources/banner.txt | 8 + src/main/resources/migrations.xml | 78 + .../textsecuregcm/tests/BaseTest.java | 11 + .../controllers/AccountControllerTest.java | 91 + .../tests/controllers/KeyControllerTest.java | 82 + .../tests/entities/ClientContactTest.java | 44 + .../tests/entities/PreKeyTest.java | 34 + .../textsecuregcm/tests/util/AuthHelper.java | 44 + src/test/resources/fixtures/contact.json | 3 + .../resources/fixtures/contact.relay.json | 4 + .../resources/fixtures/contact.relay.sms.json | 5 + src/test/resources/fixtures/prekey.json | 5 + system.properties | 1 + 103 files changed, 9737 insertions(+) create mode 100644 .gitignore create mode 100644 .jdk-overlay/jre/lib/security/US_export_policy.jar create mode 100644 .jdk-overlay/jre/lib/security/local_policy.jar create mode 100644 Procfile create mode 100644 README.md create mode 100644 assembly.xml create mode 100644 config/sample.yml create mode 100644 pom.xml create mode 100644 protobuf/Makefile create mode 100644 protobuf/OutgoingMessageSignal.proto create mode 100644 src/main/java/org/whispersystems/textsecuregcm/WhisperServerConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/AccountAuthenticator.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/AuthenticationCredentials.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/AuthorizationHeader.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/FederatedPeerAuthenticator.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/InvalidAuthorizationHeaderException.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/auth/MultiBasicAuthProvider.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/ApnConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/FederationConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/GcmConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/GraphiteConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/MemcacheConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/NexmoConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/RateLimitsConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/RedisConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/S3Configuration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/configuration/TwilioConfiguration.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/AccountController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/AttachmentController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/DirectoryController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/FederationController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/KeysController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/NoSuchUserException.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/RateLimitExceededException.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/controllers/ValidationException.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/AccountAttributes.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/AccountCount.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/ApnRegistrationId.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentDescriptor.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentUri.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/ClientContact.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/ClientContactTokens.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/ClientContacts.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/EncryptedOutgoingMessage.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/GcmRegistrationId.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessage.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessageList.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/MessageProtos.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/MessageResponse.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/PreKey.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/PreKeyList.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/entities/RelayMessage.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClient.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClientManager.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/federation/FederatedPeer.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/federation/NoSuchPeerException.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/limits/LeakyBucket.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiter.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiters.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/mappers/IOExceptionMapper.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/mappers/RateLimitExceededExceptionMapper.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/providers/MemcacheHealthCheck.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/providers/MemcachedClientFactory.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/providers/RedisClientFactory.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/providers/RedisHealthCheck.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/push/APNSender.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/push/GCMSender.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/push/PushSender.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/sms/NexmoSmsSender.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/sms/SenderFactory.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/sms/TwilioSmsSender.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/Account.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/Accounts.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/AccountsManager.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/DirectoryManager.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/Keys.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccounts.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccountsManager.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/Base64.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/ByteArrayAdapter.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/Conversions.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/Hex.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/IterablePair.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/UrlSigner.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/Util.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/util/VerificationCode.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/workers/DirectoryCommand.java create mode 100644 src/main/java/org/whispersystems/textsecuregcm/workers/DirectoryUpdater.java create mode 100644 src/main/resources/banner.txt create mode 100644 src/main/resources/migrations.xml create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/BaseTest.java create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/controllers/AccountControllerTest.java create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/controllers/KeyControllerTest.java create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/entities/ClientContactTest.java create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/entities/PreKeyTest.java create mode 100644 src/test/org/whispersystems/textsecuregcm/tests/util/AuthHelper.java create mode 100644 src/test/resources/fixtures/contact.json create mode 100644 src/test/resources/fixtures/contact.relay.json create mode 100644 src/test/resources/fixtures/contact.relay.sms.json create mode 100644 src/test/resources/fixtures/prekey.json create mode 100644 system.properties diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..bed011ea8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +target +local.properties +.idea +*.iml +run.sh +*~ +local.yml +config/production.yml +config/federated.yml diff --git a/.jdk-overlay/jre/lib/security/US_export_policy.jar b/.jdk-overlay/jre/lib/security/US_export_policy.jar new file mode 100644 index 0000000000000000000000000000000000000000..717321301e92b00fef35cf920e7a15f9ff5dce0c GIT binary patch literal 2487 zcma)82{hDe8^<)blcj7aF0#9ZFeF#X(s0LECNq>wGlq;vVJu%-5d)5$0k1Ua*PHHp}nu^ z)`kJYsKg;z!*#~Ma+8j@>hv|f$@4Cazq)9?cFDMuUy54`*BlR(*h!zV?y`dM?{o&c zht1$fU7o#p3IR85V#q@Ds>$<;5y~o4j`yWMPl6OzaFa_PYOeG(x~tP$qR4sN$6Z$j zladId7zFrF=j-e4S!2}RGD994C$L$zjX6nglM4ao;$9v!Y06>cU&?wA|KA^4S{WFb zL9wQ)NaNcbmhhKqqQPswKb|;kqW8zGmSNL|mvj&k-SY6o0PW%1kyXP)H`t@%?D2aF zjU!%6J@Mq@I1hbngWt381Tbv+VF~GE@#PSHZy6rn`jBu{Babg}Pjud)cUZtM%cUluE*0pzAbeOGhAz+BH}CMhA) z#XxWy7$(07F^i54ALYz&D;f@HH?u0@;T+|LMjuTZ(%?-?72)vw%7K?RmY0{u!*f8s zIgh+V!0r08F@g=lWFy<5`((o~oH!p&-r2=+IG~LJLZ>akz>#?H7gZ@w&2(sVMz1 zFO%|2?GtrT&(5M8b}H59`Vt`!Q15w#c?<$m6BtEh%-91*>KE-Y=XR9f;~RSEc{}V& z3%5u4CnS8osU

foVs>b6;5Ym#Dz}o8@UgzkrMp?pQ25 zHpsYnSL(tN0APD8I}RERopG675()o!dFQ8C!5EMVc{qPHlYV?u2Q_GRt`A)0XXMab(+t@%juX*{yxUPB!k7OqYny-pInqw~azn3V z<~vUFcCO$mKH_gDf#HUywAd(@Wsm?bfYjarAiHAkO%R;+m7<3L!7}kO{H9$cgX!h1 znV=+E^w?^_?ud=$mLnWb#SD&Osd`I=GrZLby%(!Qojbl@OPL8*uG(3w&RyiU)Z7#e zI`_%Xh*8c_p*;bC+|k|^a`AOdi)^|2d)XO;eJ>$hLeb76)F^aY+;aQ_^_LOhf>mb7L zVxruD+{X!>+Z~|I=XJUv#fpy77a0N_8nuX}!leMDioBR*W!tEZXJQ;1bE-Xsov4f|3<{sMtmXy1Ib0&# zP8h?4nvtId`sP#LfEDY#2_14HBs52T8>nKp?&auEQ$zny4oyb}-w~_R;!Lka#`kNG zSJ#<~14}FT6Xvt#+iRHG38y|gUefd~-Tf*ht1EtGSg4~;8r;q#;_V&Klv$rzBH{5m z5rg%y%uqEwKSkQ5jlIR(V3gNiREI*|NP--Hdyew*;+)RvkUYA`-me?+L z5Nq*iQPK9h9+>4ueknWUU!j?3xkmc%ydy0g6QrG@^=-SQuQalUFO^ahtVJ}K{%nv6 zXh@c{GLO90RIYjUTtM33UH!Znqt}D?68x*NUrEEhPVX&B?!FhkfkbvM{J~h&ucvzd z70LKi{Z=5MdTCMoq>8G-$>vwdXKAA~n;H#^Ju`i=V$zh&I$PmmVw8M|pxENDTP91p zdi2eKL7SE6UaC$|{+|Te=iKaX7FpRflM74Ic58lHSl*2+)hdc|f8Dws%W$~3)sub3 z6@YAP(_Du;t%c{07W)(1k%LbAt&NQh@I9E-f7v+pHWm)t3xDg!U{TiB8%}tfkDE8v z8i{qf>)}rDR`qaqb8+<3i&E!nQsaR#GN!Vnbo3QoMZanQ7AfA2vC<`=FWs-w?GCB@ zYqmDY(C*J`a rSyJy)?1_0ebWgm))!7s806DDC|0X2@4&>as31qF`SXtU~@4fvEf0+{G literal 0 HcmV?d00001 diff --git a/.jdk-overlay/jre/lib/security/local_policy.jar b/.jdk-overlay/jre/lib/security/local_policy.jar new file mode 100644 index 0000000000000000000000000000000000000000..c34d0362d33e269e3869806fbdec2b20084a95d5 GIT binary patch literal 2500 zcma)8c{J2*8^$z~U0EhkOt#2aG9;8Gjb4T^S;{)Ys9{7|GL_;LqOoKP4MS3)V@j4J zK6?!@gT^*7mdFyxQfNrNnfIKx_`dgi=ewWtd(QLxabM4UU)S$E*MmX;c1ZH@bB6Ne zdSjj~A<0?Wz#YsqERhykHfBgm3%I?5rj3Qvom#;tZApvOi23AFxWXa0PoDXoF@i7R zdmQu8bN*fmmM0m7B^Tw%%^%dGo8%~7Qqu7*fmtU5O`lP1k>!lNsHp3~hU!E`!|5X+ z?EcSV`Udf1h6Y{k2I?*z7b=$f8h!B327Kg`BaXe{Clk8jovU4D&b0b4#9if+m%@=u zk=SM4LQg>NS&e#{3HrdJ4}qC$ZidI|xOFPGSNYcAp4)@iKbNN_v}BePL_0-*lOC z1{=99SI$JgRcEP+4LHX!qFdT*UlZL;ue1Vl|8XSEjomwtiLEgMAS&Lzy{mM7G>%RN72jYcI zzWm`Mx@ScwjF(Fa(rx824C*Q5)WTxcc%_P== zQ7S7i>x6_D7KrRe8Mr~SwxbAxSp4t=p)973NY*_tU*HcuoQj2tiV6;qCrHSP3kE}J zrW1)04Fe=|XJ$0%M3m<~QBM``Q|1Q%yt`uE@4+C44`Lb*7b=aQ`b=e%sLD`rx2(d^ zY?9kujGMDtYL+Wyl$7aLSfym(r$ zX&D^Ih7*-Z>}#OJuOe4Jd}wWLZEIjLg@lWd1yqX|4afFF2iJ$|O6gB@nx$YJ%EGtGp;$48)}H*<>T3pH+W}1`Lo1E z-Rf~V5ni04;%wm z-~BL3JT}t5>^t-shsB-qaAPsOyO{ovRw}7$vXQycOiW3+b&EuVH$;d{t2>8VP&XmQ zvjBkeuKP*w1o%h%_$)YP{`7{x9f?Fih0NMlc>#UBrgBP8X$qc@K1k}?G-B{=d$_#H z8XVfT7Wz=Zx3BR$$QJ^Pgf4-~5*e0oq8gqJR|}nZqWp>te04RO&xEv%gPJr~?1VR;)6~(MNOZv0RTXO{OwkHfN zJlPyPW6SnJ;L6bbEKJ$)+2W5PuMRRys-(T?-!aeEQqDTLA{Qo2#B6m}q{ELcT{B-T z=d08ofx#~7uS?zJr2Ct7WGA+^XNHy5 zU=J?a^j0irN~0+|!%}K7w}z(F)|EfA7SP|3Zdt63IVt;jnwIes<1QF9Fq5X-t2{qq z;7=D^c~NI{^Qo$rg2}2lU8fc`TReNi-fO0U;*{}Ns|Ho&`)PSDNff-O`Krq5qTTHz zKEPDI2>DJbRXAI;g%Z40TDtB)uaM-zHeOS=Y>BHZ}Ax^V$s*ar8R|E#7^#_Q^duq=m0*GrhB4 zaC>YfY}OaiwIk=dT}3j-H~TI*736j%e;JUZ*C{}0YpFO7tXsiENNsA+gRiM*Oo%O6 z)9Tn*=4SiQd-S>0lH=ldnb?a3A!k3$$Xng}sIjEgge)~y#AEKnPIUr@1D^&f1HOM>GF0q zM3<&=-6P)|NA4T3W&8E^4#z0hNIBJ&R4x@Q*sOXz*GV42b}Bu+i=tK8=w8gdM5wiy z$PqRl@>nhuv@VfnLR+scUGg6b|3r*j+TCp&UiE0HAI~Z}Ky0_BT7I%dwVeY3r}0UrrM4heo?9aolDnzq{A<3>6>`&-l)* z7cDYyySobT?D*}jKihbC0DmQOu3sKL?!<}T)`h#UJ(+9G=g#9iL;Nmd{4RNU`e_DS z^22*wJD$)k(xkl$IR9)+FT&jvsVWkX$J;)j6u)n9z}(GT z>>oeJs{Qi1?7-wJtE6W$Vh>X&lxm5W-*0Pe&aN+31$ShcXg7p`R)JhD&c}cAO5_yV z@K-y$e3CrB-x^z8n%mI!_@|c#3b7qwtEFv680CQdLilB4_7?w%uvIIr_5F@zj!phI z0>=oqLi{c2-->ZX{T*n|5AX|uEAiG;uB2Pp* for more information. + +The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. +The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. + +License +--------------------- + +Copyright 2013 Open Whisper Systems + +Licensed under the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html diff --git a/assembly.xml b/assembly.xml new file mode 100644 index 000000000..e8684bc92 --- /dev/null +++ b/assembly.xml @@ -0,0 +1,25 @@ + + bin + false + + tar.gz + + + + ${project.basedir}/config + /config + + * + + + + ${project.build.directory} + / + + ${project.name}-${project.version}.jar + + + + \ No newline at end of file diff --git a/config/sample.yml b/config/sample.yml new file mode 100644 index 000000000..c72b918f3 --- /dev/null +++ b/config/sample.yml @@ -0,0 +1,94 @@ +twilio: + accountId: + accountToken: + number: + +# Optional. If specified, Nexmo will be used for non-US SMS and +# voice verification. +nexmo: + apiKey: + apiSecret: + number: + +gcm: + apiKey: + +# Optional. Only if iOS clients are supported. +apn: + # In PEM format. + certificate: + + # In PEM format. + key: + +s3: + accessKey: + accessSecret: + + # Name of the S3 bucket (needs to have been created) + # for attachments to go. Should be configured with + # correct permissions. + attachmentsBucket: + +memcache: + servers: + user: + password: + +redis: + url: + +federation: + name: + peers: + - + name: somepeer + url: https://foo.com + authenticationToken: foo + certificate: in pem format + +# Optional address of graphite server to report metrics +graphite: + host: + port: + +http: + shutdownGracePeriod: 0s + +database: + # the name of your JDBC driver + driverClass: org.postgresql.Driver + + # the username + user: + + # the password + password: + + # the JDBC URL + url: jdbc:postgresql://somehost:somport/somedb + + # any properties specific to your JDBC driver: + properties: + charSet: UTF-8 + + # the maximum amount of time to wait on an empty pool before throwing an exception + maxWaitForConnection: 1s + + # the SQL query to run when validating a connection's liveness + validationQuery: "/* MyService Health Check */ SELECT 1" + + # the minimum number of connections to keep open + minSize: 8 + + # the maximum number of connections to keep open + maxSize: 32 + + # whether or not idle connections should be validated + checkConnectionWhileIdle: false + + # how long a connection must be held before it can be validated + checkConnectionHealthWhenIdleFor: 10s + + # the maximum lifetime of an idle connection + closeConnectionIfIdleFor: 1 minute diff --git a/pom.xml b/pom.xml new file mode 100644 index 000000000..d067fc74f --- /dev/null +++ b/pom.xml @@ -0,0 +1,208 @@ + + + 4.0.0 + + 3.0.0 + + + org.whispersystems.textsecure + TextSecureServer + 0.1 + + + + bouncycastle + bcprov-jdk16 + 140 + + + com.yammer.dropwizard + dropwizard-core + 0.6.2 + + + com.yammer.metrics + metrics-graphite + 2.2.0 + + + com.google.android.gcm + gcm-server + 1.0.2 + + + com.google.code.gson + gson + 2.2.2 + + + net.spy + spymemcached + 2.10.1 + + + com.notnoop.apns + apns + 0.2.3 + + + + com.amazonaws + aws-java-sdk + 1.4.1 + + + com.google.protobuf + protobuf-java + 2.4.1 + + + + redis.clients + jedis + 2.2.1 + jar + compile + + + com.yammer.dropwizard + dropwizard-jdbi + 0.6.2 + + + com.yammer.dropwizard + dropwizard-auth + 0.6.2 + + + com.yammer.dropwizard + dropwizard-client + 0.6.2 + + + com.yammer.dropwizard + dropwizard-migrations + 0.6.2 + + + com.yammer.dropwizard + dropwizard-testing + 0.6.2 + + + + postgresql + postgresql + 9.1-901.jdbc4 + + + + com.sun.jersey + jersey-json + 1.17.1 + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.7 + 1.7 + + + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar + + + + + + org.apache.maven.plugins + maven-jar-plugin + 2.4 + + + + true + + + + + + org.apache.maven.plugins + maven-shade-plugin + 1.6 + + true + + + *:* + + META-INF/*.SF + META-INF/*.DSA + META-INF/*.RSA + + + + + + + package + + shade + + + + + + org.whispersystems.textsecuregcm.WhisperServerService + + + + + + + + + maven-assembly-plugin + 2.4 + + + assembly.xml + + + + + make-assembly + package + + single + + + + + + + + + + + gcm-server-repository + https://raw.github.com/whispersystems/maven/master/gcm-server/releases/ + + + + \ No newline at end of file diff --git a/protobuf/Makefile b/protobuf/Makefile new file mode 100644 index 000000000..ff53d0244 --- /dev/null +++ b/protobuf/Makefile @@ -0,0 +1,3 @@ + +all: + protoc --java_out=../src/main/java/ OutgoingMessageSignal.proto \ No newline at end of file diff --git a/protobuf/OutgoingMessageSignal.proto b/protobuf/OutgoingMessageSignal.proto new file mode 100644 index 000000000..06cf14600 --- /dev/null +++ b/protobuf/OutgoingMessageSignal.proto @@ -0,0 +1,29 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package textsecure; + +option java_package = "org.whispersystems.textsecuregcm.entities"; +option java_outer_classname = "MessageProtos"; + +message OutgoingMessageSignal { + optional uint32 type = 1; + optional string source = 2; + optional string relay = 3; + repeated string destinations = 4; + optional uint64 timestamp = 5; + optional bytes message = 6; +} \ No newline at end of file diff --git a/src/main/java/org/whispersystems/textsecuregcm/WhisperServerConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/WhisperServerConfiguration.java new file mode 100644 index 000000000..447631808 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/WhisperServerConfiguration.java @@ -0,0 +1,129 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.yammer.dropwizard.config.Configuration; +import com.yammer.dropwizard.db.DatabaseConfiguration; +import org.whispersystems.textsecuregcm.configuration.ApnConfiguration; +import org.whispersystems.textsecuregcm.configuration.FederationConfiguration; +import org.whispersystems.textsecuregcm.configuration.GcmConfiguration; +import org.whispersystems.textsecuregcm.configuration.GraphiteConfiguration; +import org.whispersystems.textsecuregcm.configuration.MemcacheConfiguration; +import org.whispersystems.textsecuregcm.configuration.NexmoConfiguration; +import org.whispersystems.textsecuregcm.configuration.RateLimitsConfiguration; +import org.whispersystems.textsecuregcm.configuration.RedisConfiguration; +import org.whispersystems.textsecuregcm.configuration.S3Configuration; +import org.whispersystems.textsecuregcm.configuration.TwilioConfiguration; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; + +public class WhisperServerConfiguration extends Configuration { + + @NotNull + @Valid + @JsonProperty + private TwilioConfiguration twilio; + + @JsonProperty + private NexmoConfiguration nexmo = new NexmoConfiguration(); + + @NotNull + @JsonProperty + private GcmConfiguration gcm; + + @NotNull + @Valid + @JsonProperty + private S3Configuration s3; + + @NotNull + @Valid + @JsonProperty + private MemcacheConfiguration memcache; + + @NotNull + @Valid + @JsonProperty + private RedisConfiguration redis; + + @JsonProperty + private ApnConfiguration apn = new ApnConfiguration(); + + @Valid + @JsonProperty + private FederationConfiguration federation = new FederationConfiguration(); + + @Valid + @NotNull + @JsonProperty + private DatabaseConfiguration database = new DatabaseConfiguration(); + + @Valid + @NotNull + @JsonProperty + private RateLimitsConfiguration limits = new RateLimitsConfiguration(); + + @Valid + @JsonProperty + private GraphiteConfiguration graphite = new GraphiteConfiguration(); + + public TwilioConfiguration getTwilioConfiguration() { + return twilio; + } + + public NexmoConfiguration getNexmoConfiguration() { + return nexmo; + } + + public GcmConfiguration getGcmConfiguration() { + return gcm; + } + + public ApnConfiguration getApnConfiguration() { + return apn; + } + + public S3Configuration getS3Configuration() { + return s3; + } + + public MemcacheConfiguration getMemcacheConfiguration() { + return memcache; + } + + public RedisConfiguration getRedisConfiguration() { + return redis; + } + + public DatabaseConfiguration getDatabaseConfiguration() { + return database; + } + + public RateLimitsConfiguration getLimitsConfiguration() { + return limits; + } + + public FederationConfiguration getFederationConfiguration() { + return federation; + } + + public GraphiteConfiguration getGraphiteConfiguration() { + return graphite; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java b/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java new file mode 100644 index 000000000..c60caf462 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/WhisperServerService.java @@ -0,0 +1,140 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm; + +import com.yammer.dropwizard.Service; +import com.yammer.dropwizard.config.Bootstrap; +import com.yammer.dropwizard.config.Environment; +import com.yammer.dropwizard.db.DatabaseConfiguration; +import com.yammer.dropwizard.jdbi.DBIFactory; +import com.yammer.dropwizard.migrations.MigrationsBundle; +import com.yammer.metrics.reporting.GraphiteReporter; +import net.spy.memcached.MemcachedClient; +import org.bouncycastle.jce.provider.BouncyCastleProvider; +import org.skife.jdbi.v2.DBI; +import org.whispersystems.textsecuregcm.auth.AccountAuthenticator; +import org.whispersystems.textsecuregcm.auth.FederatedPeerAuthenticator; +import org.whispersystems.textsecuregcm.auth.MultiBasicAuthProvider; +import org.whispersystems.textsecuregcm.controllers.AccountController; +import org.whispersystems.textsecuregcm.controllers.AttachmentController; +import org.whispersystems.textsecuregcm.controllers.DirectoryController; +import org.whispersystems.textsecuregcm.controllers.FederationController; +import org.whispersystems.textsecuregcm.controllers.KeysController; +import org.whispersystems.textsecuregcm.controllers.MessageController; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.federation.FederatedPeer; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.mappers.IOExceptionMapper; +import org.whispersystems.textsecuregcm.mappers.RateLimitExceededExceptionMapper; +import org.whispersystems.textsecuregcm.providers.MemcacheHealthCheck; +import org.whispersystems.textsecuregcm.providers.MemcachedClientFactory; +import org.whispersystems.textsecuregcm.providers.RedisClientFactory; +import org.whispersystems.textsecuregcm.providers.RedisHealthCheck; +import org.whispersystems.textsecuregcm.push.PushSender; +import org.whispersystems.textsecuregcm.sms.SenderFactory; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.Accounts; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.DirectoryManager; +import org.whispersystems.textsecuregcm.storage.Keys; +import org.whispersystems.textsecuregcm.storage.PendingAccounts; +import org.whispersystems.textsecuregcm.storage.PendingAccountsManager; +import org.whispersystems.textsecuregcm.util.UrlSigner; +import org.whispersystems.textsecuregcm.workers.DirectoryCommand; + +import java.security.Security; +import java.util.concurrent.TimeUnit; + +import redis.clients.jedis.JedisPool; + +public class WhisperServerService extends Service { + + static { + Security.addProvider(new BouncyCastleProvider()); + } + + @Override + public void initialize(Bootstrap bootstrap) { + bootstrap.setName("whisper-server"); + bootstrap.addCommand(new DirectoryCommand()); + bootstrap.addBundle(new MigrationsBundle() { + @Override + public DatabaseConfiguration getDatabaseConfiguration(WhisperServerConfiguration configuration) { + return configuration.getDatabaseConfiguration(); + } + }); + } + + @Override + public void run(WhisperServerConfiguration config, Environment environment) + throws Exception + { + DBIFactory dbiFactory = new DBIFactory(); + DBI jdbi = dbiFactory.build(environment, config.getDatabaseConfiguration(), "postgresql"); + + Accounts accounts = jdbi.onDemand(Accounts.class); + PendingAccounts pendingAccounts = jdbi.onDemand(PendingAccounts.class); + Keys keys = jdbi.onDemand(Keys.class); + + MemcachedClient memcachedClient = new MemcachedClientFactory(config.getMemcacheConfiguration()).getClient(); + JedisPool redisClient = new RedisClientFactory(config.getRedisConfiguration()).getRedisClientPool(); + + DirectoryManager directory = new DirectoryManager(redisClient); + PendingAccountsManager pendingAccountsManager = new PendingAccountsManager(pendingAccounts, memcachedClient); + AccountsManager accountsManager = new AccountsManager(accounts, directory, memcachedClient); + AccountAuthenticator accountAuthenticator = new AccountAuthenticator(accountsManager); + FederatedClientManager federatedClientManager = new FederatedClientManager(config.getFederationConfiguration()); + RateLimiters rateLimiters = new RateLimiters(config.getLimitsConfiguration(), memcachedClient); + SenderFactory senderFactory = new SenderFactory(config.getTwilioConfiguration(), config.getNexmoConfiguration()); + UrlSigner urlSigner = new UrlSigner(config.getS3Configuration()); + PushSender pushSender = new PushSender(config.getGcmConfiguration(), + config.getApnConfiguration(), + accountsManager, directory); + + environment.addProvider(new MultiBasicAuthProvider<>(new FederatedPeerAuthenticator(config.getFederationConfiguration()), + FederatedPeer.class, + accountAuthenticator, + Account.class, "WhisperServer")); + + environment.addResource(new AccountController(pendingAccountsManager, accountsManager, rateLimiters, senderFactory)); + environment.addResource(new DirectoryController(rateLimiters, directory)); + environment.addResource(new AttachmentController(rateLimiters, federatedClientManager, urlSigner)); + environment.addResource(new KeysController(rateLimiters, keys, federatedClientManager)); + environment.addResource(new FederationController(keys, accountsManager, pushSender, urlSigner)); + + environment.addServlet(new MessageController(rateLimiters, accountAuthenticator, + pushSender, federatedClientManager), + MessageController.PATH); + + environment.addHealthCheck(new RedisHealthCheck(redisClient)); + environment.addHealthCheck(new MemcacheHealthCheck(memcachedClient)); + + environment.addProvider(new IOExceptionMapper()); + environment.addProvider(new RateLimitExceededExceptionMapper()); + + if (config.getGraphiteConfiguration().isEnabled()) { + GraphiteReporter.enable(15, TimeUnit.SECONDS, + config.getGraphiteConfiguration().getHost(), + config.getGraphiteConfiguration().getPort()); + } + } + + public static void main(String[] args) throws Exception { + new WhisperServerService().run(args); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/AccountAuthenticator.java b/src/main/java/org/whispersystems/textsecuregcm/auth/AccountAuthenticator.java new file mode 100644 index 000000000..bb5bfb473 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/AccountAuthenticator.java @@ -0,0 +1,68 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + +import com.google.common.base.Optional; +import com.yammer.dropwizard.auth.AuthenticationException; +import com.yammer.dropwizard.auth.Authenticator; +import com.yammer.dropwizard.auth.basic.BasicCredentials; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; + +import java.util.concurrent.TimeUnit; + +public class AccountAuthenticator implements Authenticator { + + private final Meter authenticationFailedMeter = Metrics.newMeter(AccountAuthenticator.class, + "authentication", "failed", + TimeUnit.MINUTES); + + private final Meter authenticationSucceededMeter = Metrics.newMeter(AccountAuthenticator.class, + "authentication", "succeeded", + TimeUnit.MINUTES); + + private final Logger logger = LoggerFactory.getLogger(AccountAuthenticator.class); + + private final AccountsManager accountsManager; + + public AccountAuthenticator(AccountsManager accountsManager) { + this.accountsManager = accountsManager; + } + + @Override + public Optional authenticate(BasicCredentials basicCredentials) + throws AuthenticationException + { + Optional account = accountsManager.get(basicCredentials.getUsername()); + + if (!account.isPresent()) { + return Optional.absent(); + } + + if (account.get().getAuthenticationCredentials().verify(basicCredentials.getPassword())) { + authenticationSucceededMeter.mark(); + return account; + } + + authenticationFailedMeter.mark(); + return Optional.absent(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/AuthenticationCredentials.java b/src/main/java/org/whispersystems/textsecuregcm/auth/AuthenticationCredentials.java new file mode 100644 index 000000000..deeff8ec3 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/AuthenticationCredentials.java @@ -0,0 +1,76 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + +import org.apache.commons.codec.binary.Hex; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.UnsupportedEncodingException; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; + +public class AuthenticationCredentials { + + private final Logger logger = LoggerFactory.getLogger(AuthenticationCredentials.class); + + private final String hashedAuthenticationToken; + private final String salt; + + public AuthenticationCredentials(String hashedAuthenticationToken, String salt) { + this.hashedAuthenticationToken = hashedAuthenticationToken; + this.salt = salt; + } + + public AuthenticationCredentials(String authenticationToken) { + try { + this.salt = Math.abs(SecureRandom.getInstance("SHA1PRNG").nextInt()) + ""; + this.hashedAuthenticationToken = getHashedValue(salt, authenticationToken); + } catch (NoSuchAlgorithmException e) { + throw new AssertionError(e); + } + } + + public String getHashedAuthenticationToken() { + return hashedAuthenticationToken; + } + + public String getSalt() { + return salt; + } + + public boolean verify(String authenticationToken) { + String theirValue = getHashedValue(salt, authenticationToken); + + logger.debug("Comparing: " + theirValue + " , " + this.hashedAuthenticationToken); + + return theirValue.equals(this.hashedAuthenticationToken); + } + + private static String getHashedValue(String salt, String token) { + Logger logger = LoggerFactory.getLogger(AuthenticationCredentials.class); + logger.debug("Getting hashed token: " + salt + " , " + token); + + try { + return new String(Hex.encodeHex(MessageDigest.getInstance("SHA1").digest((salt + token).getBytes("UTF-8")))); + } catch (NoSuchAlgorithmException | UnsupportedEncodingException e) { + throw new AssertionError(e); + } + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/AuthorizationHeader.java b/src/main/java/org/whispersystems/textsecuregcm/auth/AuthorizationHeader.java new file mode 100644 index 000000000..d0771dd44 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/AuthorizationHeader.java @@ -0,0 +1,73 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + + +import org.whispersystems.textsecuregcm.util.Base64; +import org.whispersystems.textsecuregcm.util.Util; + +import java.io.IOException; + +public class AuthorizationHeader { + + private final String user; + private final String password; + + public AuthorizationHeader(String header) throws InvalidAuthorizationHeaderException { + try { + if (header == null) { + throw new InvalidAuthorizationHeaderException("Null header"); + } + + String[] headerParts = header.split(" "); + + if (headerParts == null || headerParts.length < 2) { + throw new InvalidAuthorizationHeaderException("Invalid authorization header: " + header); + } + + if (!"Basic".equals(headerParts[0])) { + throw new InvalidAuthorizationHeaderException("Unsupported authorization method: " + headerParts[0]); + } + + String concatenatedValues = new String(Base64.decode(headerParts[1])); + + if (Util.isEmpty(concatenatedValues)) { + throw new InvalidAuthorizationHeaderException("Bad decoded value: " + concatenatedValues); + } + + String[] credentialParts = concatenatedValues.split(":"); + + if (credentialParts == null || credentialParts.length < 2) { + throw new InvalidAuthorizationHeaderException("Badly formated credentials: " + concatenatedValues); + } + + this.user = credentialParts[0]; + this.password = credentialParts[1]; + + } catch (IOException ioe) { + throw new InvalidAuthorizationHeaderException(ioe); + } + } + + public String getUserName() { + return user; + } + + public String getPassword() { + return password; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/FederatedPeerAuthenticator.java b/src/main/java/org/whispersystems/textsecuregcm/auth/FederatedPeerAuthenticator.java new file mode 100644 index 000000000..b4736c791 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/FederatedPeerAuthenticator.java @@ -0,0 +1,74 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + +import com.google.common.base.Optional; +import com.yammer.dropwizard.auth.AuthenticationException; +import com.yammer.dropwizard.auth.Authenticator; +import com.yammer.dropwizard.auth.basic.BasicCredentials; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.configuration.FederationConfiguration; +import org.whispersystems.textsecuregcm.federation.FederatedPeer; + +import java.util.List; +import java.util.concurrent.TimeUnit; + + +public class FederatedPeerAuthenticator implements Authenticator { + + private final Meter authenticationFailedMeter = Metrics.newMeter(FederatedPeerAuthenticator.class, + "authentication", "failed", + TimeUnit.MINUTES); + + private final Meter authenticationSucceededMeter = Metrics.newMeter(FederatedPeerAuthenticator.class, + "authentication", "succeeded", + TimeUnit.MINUTES); + + private final Logger logger = LoggerFactory.getLogger(FederatedPeerAuthenticator.class); + + private final List peers; + + public FederatedPeerAuthenticator(FederationConfiguration config) { + this.peers = config.getPeers(); + } + + @Override + public Optional authenticate(BasicCredentials basicCredentials) + throws AuthenticationException + { + + if (peers == null) { + authenticationFailedMeter.mark(); + return Optional.absent(); + } + + for (FederatedPeer peer : peers) { + if (basicCredentials.getUsername().equals(peer.getName()) && + basicCredentials.getPassword().equals(peer.getAuthenticationToken())) + { + authenticationSucceededMeter.mark(); + return Optional.of(peer); + } + } + + authenticationFailedMeter.mark(); + return Optional.absent(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/InvalidAuthorizationHeaderException.java b/src/main/java/org/whispersystems/textsecuregcm/auth/InvalidAuthorizationHeaderException.java new file mode 100644 index 000000000..b0c0f5a34 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/InvalidAuthorizationHeaderException.java @@ -0,0 +1,28 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + + +public class InvalidAuthorizationHeaderException extends Exception { + public InvalidAuthorizationHeaderException(String s) { + super(s); + } + + public InvalidAuthorizationHeaderException(Exception e) { + super(e); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/auth/MultiBasicAuthProvider.java b/src/main/java/org/whispersystems/textsecuregcm/auth/MultiBasicAuthProvider.java new file mode 100644 index 000000000..05034aa90 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/auth/MultiBasicAuthProvider.java @@ -0,0 +1,69 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.auth; + +import com.sun.jersey.api.model.Parameter; +import com.sun.jersey.core.spi.component.ComponentContext; +import com.sun.jersey.core.spi.component.ComponentScope; +import com.sun.jersey.spi.inject.Injectable; +import com.sun.jersey.spi.inject.InjectableProvider; +import com.yammer.dropwizard.auth.Auth; +import com.yammer.dropwizard.auth.Authenticator; +import com.yammer.dropwizard.auth.basic.BasicAuthProvider; +import com.yammer.dropwizard.auth.basic.BasicCredentials; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class MultiBasicAuthProvider implements InjectableProvider { + + private final Logger logger = LoggerFactory.getLogger(MultiBasicAuthProvider.class); + + private final BasicAuthProvider provider1; + private final BasicAuthProvider provider2; + + private final Class clazz1; + private final Class clazz2; + + public MultiBasicAuthProvider(Authenticator authenticator1, + Class clazz1, + Authenticator authenticator2, + Class clazz2, + String realm) + { + this.provider1 = new BasicAuthProvider(authenticator1, realm); + this.provider2 = new BasicAuthProvider(authenticator2, realm); + this.clazz1 = clazz1; + this.clazz2 = clazz2; + } + + + @Override + public ComponentScope getScope() { + return ComponentScope.PerRequest; + } + + @Override + public Injectable getInjectable(ComponentContext componentContext, + Auth auth, Parameter parameter) + { + if (parameter.getParameterClass().equals(clazz1)) { + return this.provider1.getInjectable(componentContext, auth, parameter); + } else { + return this.provider2.getInjectable(componentContext, auth, parameter); + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/ApnConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/ApnConfiguration.java new file mode 100644 index 000000000..5c2ccf967 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/ApnConfiguration.java @@ -0,0 +1,40 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + + +public class ApnConfiguration { + + @NotEmpty + @JsonProperty + private String certificate; + + @NotEmpty + @JsonProperty + private String key; + + public String getCertificate() { + return certificate; + } + + public String getKey() { + return key; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/FederationConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/FederationConfiguration.java new file mode 100644 index 000000000..c4f3484a6 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/FederationConfiguration.java @@ -0,0 +1,68 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonParser; +import org.whispersystems.textsecuregcm.federation.FederatedPeer; + +import java.util.LinkedList; +import java.util.List; + +public class FederationConfiguration { + + @JsonProperty + private List peers; + + @JsonProperty + private String name; + + @JsonProperty + private String herokuPeers; + + public List getPeers() { + if (peers != null) { + return peers; + } + + if (herokuPeers != null) { + List peers = new LinkedList<>(); + JsonElement root = new JsonParser().parse(herokuPeers); + JsonArray peerElements = root.getAsJsonArray(); + + for (JsonElement peer : peerElements) { + String name = peer.getAsJsonObject().get("name").getAsString(); + String url = peer.getAsJsonObject().get("url").getAsString(); + String authenticationToken = peer.getAsJsonObject().get("authenticationToken").getAsString(); + String certificate = peer.getAsJsonObject().get("certificate").getAsString(); + + peers.add(new FederatedPeer(name, url, authenticationToken, certificate)); + } + + return peers; + } + + return peers; + } + + public String getName() { + return name; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/GcmConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/GcmConfiguration.java new file mode 100644 index 000000000..7b8300f27 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/GcmConfiguration.java @@ -0,0 +1,31 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class GcmConfiguration { + + @NotEmpty + @JsonProperty + private String apiKey; + + public String getApiKey() { + return apiKey; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/GraphiteConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/GraphiteConfiguration.java new file mode 100644 index 000000000..7e0442da9 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/GraphiteConfiguration.java @@ -0,0 +1,39 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public class GraphiteConfiguration { + @JsonProperty + private String host; + + @JsonProperty + private int port; + + public String getHost() { + return host; + } + + public int getPort() { + return port; + } + + public boolean isEnabled() { + return host != null && port != 0; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/MemcacheConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/MemcacheConfiguration.java new file mode 100644 index 000000000..3ae05e83a --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/MemcacheConfiguration.java @@ -0,0 +1,46 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class MemcacheConfiguration { + + @NotEmpty + @JsonProperty + private String servers; + + @JsonProperty + private String user; + + @JsonProperty + private String password; + + + public String getServers() { + return servers; + } + + public String getUser() { + return user; + } + + public String getPassword() { + return password; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/NexmoConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/NexmoConfiguration.java new file mode 100644 index 000000000..b97311d22 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/NexmoConfiguration.java @@ -0,0 +1,43 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public class NexmoConfiguration { + + @JsonProperty + private String apiKey; + + @JsonProperty + private String apiSecret; + + @JsonProperty + private String number; + + public String getApiKey() { + return apiKey; + } + + public String getApiSecret() { + return apiSecret; + } + + public String getNumber() { + return number; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/RateLimitsConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/RateLimitsConfiguration.java new file mode 100644 index 000000000..e78bfd54d --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/RateLimitsConfiguration.java @@ -0,0 +1,94 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public class RateLimitsConfiguration { + + @JsonProperty + private RateLimitConfiguration smsDestination = new RateLimitConfiguration(2, 2); + + @JsonProperty + private RateLimitConfiguration voiceDestination = new RateLimitConfiguration(2, 1.0 / 2.0); + + @JsonProperty + private RateLimitConfiguration verifyNumber = new RateLimitConfiguration(2, 2); + + @JsonProperty + private RateLimitConfiguration attachments = new RateLimitConfiguration(50, 50); + + @JsonProperty + private RateLimitConfiguration contactQueries = new RateLimitConfiguration(50000, 50000); + + @JsonProperty + private RateLimitConfiguration prekeys = new RateLimitConfiguration(3, 1.0 / 10.0); + + @JsonProperty + private RateLimitConfiguration messages = new RateLimitConfiguration(60, 60); + + public RateLimitConfiguration getMessages() { + return messages; + } + + public RateLimitConfiguration getPreKeys() { + return prekeys; + } + + public RateLimitConfiguration getContactQueries() { + return contactQueries; + } + + public RateLimitConfiguration getAttachments() { + return attachments; + } + + public RateLimitConfiguration getSmsDestination() { + return smsDestination; + } + + public RateLimitConfiguration getVoiceDestination() { + return voiceDestination; + } + + public RateLimitConfiguration getVerifyNumber() { + return verifyNumber; + } + + public static class RateLimitConfiguration { + @JsonProperty + private int bucketSize; + + @JsonProperty + private double leakRatePerMinute; + + public RateLimitConfiguration(int bucketSize, double leakRatePerMinute) { + this.bucketSize = bucketSize; + this.leakRatePerMinute = leakRatePerMinute; + } + + public RateLimitConfiguration() {} + + public int getBucketSize() { + return bucketSize; + } + + public double getLeakRatePerMinute() { + return leakRatePerMinute; + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/RedisConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/RedisConfiguration.java new file mode 100644 index 000000000..cd71ecac6 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/RedisConfiguration.java @@ -0,0 +1,33 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; +import org.hibernate.validator.constraints.URL; + +public class RedisConfiguration { + + @JsonProperty + @NotEmpty + private String url; + + public String getUrl() { + return url; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/S3Configuration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/S3Configuration.java new file mode 100644 index 000000000..83d726774 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/S3Configuration.java @@ -0,0 +1,47 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class S3Configuration { + + @NotEmpty + @JsonProperty + private String accessKey; + + @NotEmpty + @JsonProperty + private String accessSecret; + + @NotEmpty + @JsonProperty + private String attachmentsBucket; + + public String getAccessKey() { + return accessKey; + } + + public String getAccessSecret() { + return accessSecret; + } + + public String getAttachmentsBucket() { + return attachmentsBucket; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/configuration/TwilioConfiguration.java b/src/main/java/org/whispersystems/textsecuregcm/configuration/TwilioConfiguration.java new file mode 100644 index 000000000..cdc4691e3 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/configuration/TwilioConfiguration.java @@ -0,0 +1,47 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.configuration; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class TwilioConfiguration { + + @NotEmpty + @JsonProperty + private String accountId; + + @NotEmpty + @JsonProperty + private String accountToken; + + @NotEmpty + @JsonProperty + private String number; + + public String getAccountId() { + return accountId; + } + + public String getAccountToken() { + return accountToken; + } + + public String getNumber() { + return number; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/AccountController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/AccountController.java new file mode 100644 index 000000000..f41139bdb --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/AccountController.java @@ -0,0 +1,195 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.google.common.base.Optional; +import com.yammer.dropwizard.auth.Auth; +import com.yammer.metrics.annotation.Timed; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.auth.AuthenticationCredentials; +import org.whispersystems.textsecuregcm.auth.AuthorizationHeader; +import org.whispersystems.textsecuregcm.auth.InvalidAuthorizationHeaderException; +import org.whispersystems.textsecuregcm.entities.AccountAttributes; +import org.whispersystems.textsecuregcm.entities.ApnRegistrationId; +import org.whispersystems.textsecuregcm.entities.GcmRegistrationId; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.sms.SenderFactory; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.PendingAccountsManager; +import org.whispersystems.textsecuregcm.util.Util; +import org.whispersystems.textsecuregcm.util.VerificationCode; + +import javax.validation.Valid; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.HeaderParam; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; + +@Path("/v1/accounts") +public class AccountController { + + private final Logger logger = LoggerFactory.getLogger(AccountController.class); + + private final PendingAccountsManager pendingAccounts; + private final AccountsManager accounts; + private final RateLimiters rateLimiters; + private final SenderFactory senderFactory; + + public AccountController(PendingAccountsManager pendingAccounts, + AccountsManager accounts, + RateLimiters rateLimiters, + SenderFactory smsSenderFactory) + { + this.pendingAccounts = pendingAccounts; + this.accounts = accounts; + this.rateLimiters = rateLimiters; + this.senderFactory = smsSenderFactory; + } + + + @Timed + @GET + @Path("/{transport}/code/{number}") + public Response createAccount(@PathParam("transport") String transport, + @PathParam("number") String number) + throws IOException, RateLimitExceededException + { + if (!Util.isValidNumber(number)) { + logger.debug("Invalid number: " + number); + throw new WebApplicationException(Response.status(400).build()); + } + + switch (transport) { + case "sms": + rateLimiters.getSmsDestinationLimiter().validate(number); + break; + case "voice": + rateLimiters.getVoiceDestinationLimiter().validate(number); + break; + default: + throw new WebApplicationException(Response.status(415).build()); + } + + VerificationCode verificationCode = generateVerificationCode(); + pendingAccounts.store(number, verificationCode.getVerificationCode()); + + if (transport.equals("sms")) { + senderFactory.getSmsSender(number).deliverSmsVerification(number, verificationCode.getVerificationCodeDisplay()); + } else if (transport.equals("voice")) { + senderFactory.getVoxSender(number).deliverVoxVerification(number, verificationCode.getVerificationCodeSpeech()); + } + + return Response.ok().build(); + } + + @Timed + @PUT + @Consumes(MediaType.APPLICATION_JSON) + @Path("/code/{verification_code}") + public void verifyAccount(@PathParam("verification_code") String verificationCode, + @HeaderParam("Authorization") String authorizationHeader, + @Valid AccountAttributes accountAttributes) + throws RateLimitExceededException + { + try { + AuthorizationHeader header = new AuthorizationHeader(authorizationHeader); + String number = header.getUserName(); + String password = header.getPassword(); + + rateLimiters.getVerifyLimiter().validate(number); + + Optional storedVerificationCode = pendingAccounts.getCodeForNumber(number); + + if (!storedVerificationCode.isPresent() || + !verificationCode.equals(storedVerificationCode.get())) + { + throw new WebApplicationException(Response.status(403).build()); + } + + Account account = new Account(); + account.setNumber(number); + account.setAuthenticationCredentials(new AuthenticationCredentials(password)); + account.setSignalingKey(accountAttributes.getSignalingKey()); + account.setSupportsSms(accountAttributes.getSupportsSms()); + + accounts.create(account); + logger.debug("Stored account..."); + + } catch (InvalidAuthorizationHeaderException e) { + logger.info("Bad Authorization Header", e); + throw new WebApplicationException(Response.status(401).build()); + } + } + + @Timed + @PUT + @Path("/gcm/") + @Consumes(MediaType.APPLICATION_JSON) + public void setGcmRegistrationId(@Auth Account account, @Valid GcmRegistrationId registrationId) { + account.setApnRegistrationId(null); + account.setGcmRegistrationId(registrationId.getGcmRegistrationId()); + accounts.update(account); + } + + @Timed + @DELETE + @Path("/gcm/") + public void deleteGcmRegistrationId(@Auth Account account) { + account.setGcmRegistrationId(null); + accounts.update(account); + } + + @Timed + @PUT + @Path("/apn/") + @Consumes(MediaType.APPLICATION_JSON) + public void setApnRegistrationId(@Auth Account account, @Valid ApnRegistrationId registrationId) { + account.setApnRegistrationId(registrationId.getApnRegistrationId()); + account.setGcmRegistrationId(null); + accounts.update(account); + } + + @Timed + @DELETE + @Path("/apn/") + public void deleteApnRegistrationId(@Auth Account account) { + account.setApnRegistrationId(null); + accounts.update(account); + } + + private VerificationCode generateVerificationCode() { + try { + SecureRandom random = SecureRandom.getInstance("SHA1PRNG"); + int randomInt = 100000 + random.nextInt(900000); + return new VerificationCode(randomInt); + } catch (NoSuchAlgorithmException e) { + throw new AssertionError(e); + } + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/AttachmentController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/AttachmentController.java new file mode 100644 index 000000000..38d0fd8a7 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/AttachmentController.java @@ -0,0 +1,113 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.amazonaws.HttpMethod; +import com.yammer.dropwizard.auth.Auth; +import com.yammer.metrics.annotation.Timed; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.AttachmentDescriptor; +import org.whispersystems.textsecuregcm.entities.AttachmentUri; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.federation.NoSuchPeerException; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.util.Conversions; +import org.whispersystems.textsecuregcm.util.UrlSigner; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.net.URISyntaxException; +import java.net.URL; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; + + +@Path("/v1/attachments") +public class AttachmentController { + + private final Logger logger = LoggerFactory.getLogger(AttachmentController.class); + + private final RateLimiters rateLimiters; + private final FederatedClientManager federatedClientManager; + private final UrlSigner urlSigner; + + public AttachmentController(RateLimiters rateLimiters, + FederatedClientManager federatedClientManager, + UrlSigner urlSigner) + { + this.rateLimiters = rateLimiters; + this.federatedClientManager = federatedClientManager; + this.urlSigner = urlSigner; + } + + @Timed + @GET + @Produces(MediaType.APPLICATION_JSON) + public Response allocateAttachment(@Auth Account account) throws RateLimitExceededException { + rateLimiters.getAttachmentLimiter().validate(account.getNumber()); + + long attachmentId = generateAttachmentId(); + URL url = urlSigner.getPreSignedUrl(attachmentId, HttpMethod.PUT); + AttachmentDescriptor descriptor = new AttachmentDescriptor(attachmentId, url.toExternalForm()); + + return Response.ok().entity(descriptor).build(); + } + + @Timed + @GET + @Produces(MediaType.APPLICATION_JSON) + @Path("/{attachmentId}") + public Response redirectToAttachment(@Auth Account account, + @PathParam("attachmentId") long attachmentId, + @QueryParam("relay") String relay) + { + try { + URL url; + + if (relay == null) url = urlSigner.getPreSignedUrl(attachmentId, HttpMethod.GET); + else url = federatedClientManager.getClient(relay).getSignedAttachmentUri(attachmentId); + + return Response.ok().entity(new AttachmentUri(url)).build(); + } catch (IOException e) { + logger.warn("No conectivity", e); + return Response.status(500).build(); + } catch (NoSuchPeerException e) { + logger.info("No such peer: " + relay); + return Response.status(404).build(); + } + } + + private long generateAttachmentId() { + try { + byte[] attachmentBytes = new byte[8]; + SecureRandom.getInstance("SHA1PRNG").nextBytes(attachmentBytes); + + attachmentBytes[0] = (byte)(attachmentBytes[0] & 0x7F); + return Conversions.byteArrayToLong(attachmentBytes); + } catch (NoSuchAlgorithmException nsae) { + throw new AssertionError(nsae); + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/DirectoryController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/DirectoryController.java new file mode 100644 index 000000000..a1b367f17 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/DirectoryController.java @@ -0,0 +1,105 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.google.common.base.Optional; +import com.yammer.dropwizard.auth.Auth; +import com.yammer.metrics.annotation.Metered; +import com.yammer.metrics.annotation.Timed; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.entities.ClientContactTokens; +import org.whispersystems.textsecuregcm.entities.ClientContacts; +import org.whispersystems.textsecuregcm.storage.DirectoryManager; +import org.whispersystems.textsecuregcm.util.Base64; + +import javax.validation.Valid; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.LinkedList; +import java.util.List; + +@Path("/v1/directory") +public class DirectoryController { + + private final Logger logger = LoggerFactory.getLogger(DirectoryController.class); + + private final RateLimiters rateLimiters; + private final DirectoryManager directory; + + public DirectoryController(RateLimiters rateLimiters, DirectoryManager directory) { + this.directory = directory; + this.rateLimiters = rateLimiters; + } + + @Timed() + @GET + @Path("/{token}") + @Produces(MediaType.APPLICATION_JSON) + public Response getTokenPresence(@Auth Account account, @PathParam("token") String token) + throws RateLimitExceededException + { + rateLimiters.getContactsLimiter().validate(account.getNumber()); + + try { + Optional contact = directory.get(Base64.decodeWithoutPadding(token)); + + if (contact.isPresent()) return Response.ok().entity(contact.get()).build(); + else return Response.status(404).build(); + + } catch (IOException e) { + logger.info("Bad token", e); + return Response.status(404).build(); + } + } + + @Timed() + @PUT + @Path("/tokens") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public ClientContacts getContactIntersection(@Auth Account account, @Valid ClientContactTokens contacts) + throws RateLimitExceededException + { + rateLimiters.getContactsLimiter().validate(account.getNumber(), contacts.getContacts().size()); + + try { + List tokens = new LinkedList<>(); + + for (String encodedContact : contacts.getContacts()) { + tokens.add(Base64.decodeWithoutPadding(encodedContact)); + } + + List intersection = directory.get(tokens); + return new ClientContacts(intersection); + } catch (IOException e) { + logger.info("Bad token", e); + throw new WebApplicationException(Response.status(400).build()); + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/FederationController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/FederationController.java new file mode 100644 index 000000000..e7dd510e3 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/FederationController.java @@ -0,0 +1,157 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.amazonaws.HttpMethod; +import com.google.protobuf.InvalidProtocolBufferException; +import com.yammer.dropwizard.auth.Auth; +import com.yammer.metrics.annotation.Timed; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.AccountCount; +import org.whispersystems.textsecuregcm.entities.AttachmentUri; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.entities.ClientContacts; +import org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal; +import org.whispersystems.textsecuregcm.entities.PreKey; +import org.whispersystems.textsecuregcm.entities.RelayMessage; +import org.whispersystems.textsecuregcm.federation.FederatedPeer; +import org.whispersystems.textsecuregcm.push.PushSender; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.Keys; +import org.whispersystems.textsecuregcm.util.UrlSigner; +import org.whispersystems.textsecuregcm.util.Util; + +import javax.validation.Valid; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.net.URL; +import java.util.LinkedList; +import java.util.List; + +@Path("/v1/federation") +public class FederationController { + + private final Logger logger = LoggerFactory.getLogger(FederationController.class); + + private static final int ACCOUNT_CHUNK_SIZE = 10000; + + private final PushSender pushSender; + private final Keys keys; + private final AccountsManager accounts; + private final UrlSigner urlSigner; + + public FederationController(Keys keys, AccountsManager accounts, PushSender pushSender, UrlSigner urlSigner) { + this.keys = keys; + this.accounts = accounts; + this.pushSender = pushSender; + this.urlSigner = urlSigner; + } + + @Timed + @GET + @Path("/attachment/{attachmentId}") + @Produces(MediaType.APPLICATION_JSON) + public AttachmentUri getSignedAttachmentUri(@Auth FederatedPeer peer, + @PathParam("attachmentId") long attachmentId) + { + URL url = urlSigner.getPreSignedUrl(attachmentId, HttpMethod.GET); + return new AttachmentUri(url); + } + + @Timed + @GET + @Path("/key/{number}") + @Produces(MediaType.APPLICATION_JSON) + public PreKey getKey(@Auth FederatedPeer peer, + @PathParam("number") String number) + { + PreKey preKey = keys.get(number); + + if (preKey == null) { + throw new WebApplicationException(Response.status(404).build()); + } + + return preKey; + } + + @Timed + @PUT + @Path("/message") + @Consumes(MediaType.APPLICATION_JSON) + public void relayMessage(@Auth FederatedPeer peer, @Valid RelayMessage message) + throws IOException + { + try { + OutgoingMessageSignal signal = OutgoingMessageSignal.parseFrom(message.getOutgoingMessageSignal()) + .toBuilder() + .setRelay(peer.getName()) + .build(); + + pushSender.sendMessage(message.getDestination(), signal); + } catch (InvalidProtocolBufferException ipe) { + logger.warn("ProtoBuf", ipe); + throw new WebApplicationException(Response.status(400).build()); + } catch (NoSuchUserException e) { + logger.debug("No User", e); + throw new WebApplicationException(Response.status(404).build()); + } + } + + @Timed + @GET + @Path("/user_count") + @Produces(MediaType.APPLICATION_JSON) + public AccountCount getUserCount(@Auth FederatedPeer peer) { + return new AccountCount((int)accounts.getCount()); + } + + @Timed + @GET + @Path("/user_tokens/{offset}") + @Produces(MediaType.APPLICATION_JSON) + public ClientContacts getUserTokens(@Auth FederatedPeer peer, + @PathParam("offset") int offset) + { + List accountList = accounts.getAll(offset, ACCOUNT_CHUNK_SIZE); + List clientContacts = new LinkedList<>(); + + for (Account account : accountList) { + byte[] token = Util.getContactToken(account.getNumber()); + ClientContact clientContact = new ClientContact(token, null, account.getSupportsSms()); + + if (Util.isEmpty(account.getApnRegistrationId()) && + Util.isEmpty(account.getGcmRegistrationId())) + { + clientContact.setInactive(true); + } + + clientContacts.add(clientContact); + } + + return new ClientContacts(clientContacts); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/KeysController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/KeysController.java new file mode 100644 index 000000000..ad836afcd --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/KeysController.java @@ -0,0 +1,92 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.yammer.dropwizard.auth.Auth; +import com.yammer.metrics.annotation.Timed; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.PreKey; +import org.whispersystems.textsecuregcm.entities.PreKeyList; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.federation.NoSuchPeerException; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.Keys; + +import javax.validation.Valid; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; + +@Path("/v1/keys") +public class KeysController { + + private final Logger logger = LoggerFactory.getLogger(AccountController.class); + + private final RateLimiters rateLimiters; + private final Keys keys; + private final FederatedClientManager federatedClientManager; + + public KeysController(RateLimiters rateLimiters, Keys keys, + FederatedClientManager federatedClientManager) + { + this.rateLimiters = rateLimiters; + this.keys = keys; + this.federatedClientManager = federatedClientManager; + } + + @Timed + @PUT + @Consumes(MediaType.APPLICATION_JSON) + public void setKeys(@Auth Account account, @Valid PreKeyList preKeys) { + keys.store(account.getNumber(), preKeys.getLastResortKey(), preKeys.getKeys()); + } + + @Timed + @GET + @Path("/{number}") + @Produces(MediaType.APPLICATION_JSON) + public PreKey get(@Auth Account account, + @PathParam("number") String number, + @QueryParam("relay") String relay) + throws RateLimitExceededException + { + rateLimiters.getPreKeysLimiter().validate(account.getNumber() + "__" + number); + + try { + PreKey key; + + if (relay == null) key = keys.get(number); + else key = federatedClientManager.getClient(relay).getKey(number); + + if (key == null) throw new WebApplicationException(Response.status(404).build()); + else return key; + } catch (NoSuchPeerException e) { + logger.info("No peer: " + relay); + throw new WebApplicationException(Response.status(404).build()); + } + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java new file mode 100644 index 000000000..4c6601a6a --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java @@ -0,0 +1,313 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.google.common.base.Optional; +import com.google.protobuf.ByteString; +import com.yammer.dropwizard.auth.AuthenticationException; +import com.yammer.dropwizard.auth.basic.BasicCredentials; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import com.yammer.metrics.core.Timer; +import com.yammer.metrics.core.TimerContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.auth.AccountAuthenticator; +import org.whispersystems.textsecuregcm.auth.AuthorizationHeader; +import org.whispersystems.textsecuregcm.auth.InvalidAuthorizationHeaderException; +import org.whispersystems.textsecuregcm.entities.IncomingMessage; +import org.whispersystems.textsecuregcm.entities.IncomingMessageList; +import org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal; +import org.whispersystems.textsecuregcm.entities.MessageResponse; +import org.whispersystems.textsecuregcm.federation.FederatedClient; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.federation.NoSuchPeerException; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.push.PushSender; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.util.Base64; +import org.whispersystems.textsecuregcm.util.IterablePair; +import org.whispersystems.textsecuregcm.util.IterablePair.Pair; +import org.whispersystems.textsecuregcm.util.Util; + +import javax.servlet.AsyncContext; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.BufferedReader; +import java.io.IOException; +import java.util.LinkedList; +import java.util.List; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; + +public class MessageController extends HttpServlet { + + public static final String PATH = "/v1/messages/"; + + private final Meter successMeter = Metrics.newMeter(MessageController.class, "deliver_message", "success", TimeUnit.MINUTES); + private final Meter failureMeter = Metrics.newMeter(MessageController.class, "deliver_message", "failure", TimeUnit.MINUTES); + private final Timer timer = Metrics.newTimer(MessageController.class, "deliver_message_time", TimeUnit.MILLISECONDS, TimeUnit.MINUTES); + private final Logger logger = LoggerFactory.getLogger(MessageController.class); + + private final RateLimiters rateLimiters; + private final AccountAuthenticator accountAuthenticator; + private final PushSender pushSender; + private final FederatedClientManager federatedClientManager; + private final ObjectMapper objectMapper; + private final ExecutorService executor; + + public MessageController(RateLimiters rateLimiters, + AccountAuthenticator accountAuthenticator, + PushSender pushSender, + FederatedClientManager federatedClientManager) + { + this.rateLimiters = rateLimiters; + this.accountAuthenticator = accountAuthenticator; + this.pushSender = pushSender; + this.federatedClientManager = federatedClientManager; + this.objectMapper = new ObjectMapper(); + this.executor = Executors.newFixedThreadPool(10); + } + + @Override + protected void doPost(HttpServletRequest req, HttpServletResponse resp) { + TimerContext timerContext = timer.time(); + + try { + Account sender = authenticate(req); + IncomingMessageList messages = parseIncomingMessages(req); + + rateLimiters.getMessagesLimiter().validate(sender.getNumber()); + + List incomingMessages = messages.getMessages(); + List outgoingMessages = getOutgoingMessageSignals(sender.getNumber(), + incomingMessages); + + IterablePair listPair = new IterablePair<>(incomingMessages, + outgoingMessages); + + handleAsyncDelivery(timerContext, req.startAsync(), listPair); + } catch (AuthenticationException e) { + failureMeter.mark(); + timerContext.stop(); + resp.setStatus(401); + } catch (ValidationException e) { + failureMeter.mark(); + timerContext.stop(); + resp.setStatus(415); + } catch (IOException e) { + logger.warn("IOE", e); + failureMeter.mark(); + timerContext.stop(); + resp.setStatus(501); + } catch (RateLimitExceededException e) { + timerContext.stop(); + failureMeter.mark(); + resp.setStatus(413); + } + } + + private void handleAsyncDelivery(final TimerContext timerContext, + final AsyncContext context, + final IterablePair listPair) + { + executor.submit(new Runnable() { + @Override + public void run() { + List success = new LinkedList<>(); + List failure = new LinkedList<>(); + HttpServletResponse response = (HttpServletResponse) context.getResponse(); + + try { + for (Pair messagePair : listPair) { + String destination = messagePair.first().getDestination(); + String relay = messagePair.first().getRelay(); + + try { + if (Util.isEmpty(relay)) sendLocalMessage(destination, messagePair.second()); + else sendRelayMessage(relay, destination, messagePair.second()); + success.add(destination); + } catch (NoSuchUserException e) { + logger.debug("No such user", e); + failure.add(destination); + } + } + + byte[] responseData = serializeResponse(new MessageResponse(success, failure)); + response.setContentLength(responseData.length); + response.getOutputStream().write(responseData); + context.complete(); + successMeter.mark(); + } catch (IOException e) { + logger.warn("Async Handler", e); + failureMeter.mark(); + response.setStatus(501); + context.complete(); + } + + timerContext.stop(); + } + }); + } + + private void sendLocalMessage(String destination, OutgoingMessageSignal outgoingMessage) + throws IOException, NoSuchUserException + { + pushSender.sendMessage(destination, outgoingMessage); + } + + private void sendRelayMessage(String relay, String destination, OutgoingMessageSignal outgoingMessage) + throws IOException, NoSuchUserException + { + try { + FederatedClient client = federatedClientManager.getClient(relay); + client.sendMessage(destination, outgoingMessage); + } catch (NoSuchPeerException e) { + logger.info("No such peer", e); + throw new NoSuchUserException(e); + } + } + + private List getOutgoingMessageSignals(String number, + List incomingMessages) + { + List outgoingMessages = new LinkedList<>(); + + for (IncomingMessage incoming : incomingMessages) { + OutgoingMessageSignal.Builder outgoingMessage = OutgoingMessageSignal.newBuilder(); + outgoingMessage.setType(incoming.getType()); + outgoingMessage.setSource(number); + + byte[] messageBody = getMessageBody(incoming); + + if (messageBody != null) { + outgoingMessage.setMessage(ByteString.copyFrom(messageBody)); + } + + outgoingMessage.setTimestamp(System.currentTimeMillis()); + + int index = 0; + + for (IncomingMessage sub : incomingMessages) { + if (sub != incoming) { + outgoingMessage.setDestinations(index++, sub.getDestination()); + } + } + + outgoingMessages.add(outgoingMessage.build()); + } + + return outgoingMessages; + } + + private byte[] getMessageBody(IncomingMessage message) { + try { + return Base64.decode(message.getBody()); + } catch (IOException ioe) { + ioe.printStackTrace(); + return null; + } + } + + private byte[] serializeResponse(MessageResponse response) throws IOException { + try { + return objectMapper.writeValueAsBytes(response); + } catch (JsonProcessingException e) { + throw new IOException(e); + } + } + + private IncomingMessageList parseIncomingMessages(HttpServletRequest request) + throws IOException, ValidationException + { + BufferedReader reader = request.getReader(); + StringBuilder content = new StringBuilder(); + String line; + + while ((line = reader.readLine()) != null) { + content.append(line); + } + + IncomingMessageList messages = objectMapper.readValue(content.toString(), + IncomingMessageList.class); + + if (messages.getMessages() == null) { + throw new ValidationException(); + } + + for (IncomingMessage message : messages.getMessages()) { + if (message.getBody() == null) throw new ValidationException(); + if (message.getDestination() == null) throw new ValidationException(); + } + + return messages; + } + + private Account authenticate(HttpServletRequest request) throws AuthenticationException { + try { + AuthorizationHeader authorizationHeader = new AuthorizationHeader(request.getHeader("Authorization")); + BasicCredentials credentials = new BasicCredentials(authorizationHeader.getUserName(), + authorizationHeader.getPassword() ); + + Optional account = accountAuthenticator.authenticate(credentials); + + if (account.isPresent()) return account.get(); + else throw new AuthenticationException("Bad credentials"); + } catch (InvalidAuthorizationHeaderException e) { + throw new AuthenticationException(e); + } + } + + + + +// @Timed +// @POST +// @Consumes(MediaType.APPLICATION_JSON) +// @Produces(MediaType.APPLICATION_JSON) +// public MessageResponse sendMessage(@Auth Account sender, IncomingMessageList messages) +// throws IOException +// { +// List success = new LinkedList<>(); +// List failure = new LinkedList<>(); +// List incomingMessages = messages.getMessages(); +// List outgoingMessages = getOutgoingMessageSignals(sender.getNumber(), incomingMessages); +// +// IterablePair listPair = new IterablePair<>(incomingMessages, outgoingMessages); +// +// for (Pair messagePair : listPair) { +// String destination = messagePair.first().getDestination(); +// String relay = messagePair.first().getRelay(); +// +// try { +// if (Util.isEmpty(relay)) sendLocalMessage(destination, messagePair.second()); +// else sendRelayMessage(relay, destination, messagePair.second()); +// success.add(destination); +// } catch (NoSuchUserException e) { +// logger.debug("No such user", e); +// failure.add(destination); +// } +// } +// +// return new MessageResponse(success, failure); +// } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/NoSuchUserException.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/NoSuchUserException.java new file mode 100644 index 000000000..646ef5930 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/NoSuchUserException.java @@ -0,0 +1,45 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +import org.whispersystems.textsecuregcm.federation.NoSuchPeerException; + +import java.util.LinkedList; +import java.util.List; + +public class NoSuchUserException extends Exception { + + private List missing; + + public NoSuchUserException(String user) { + super(user); + missing = new LinkedList(); + missing.add(user); + } + + public NoSuchUserException(List missing) { + this.missing = missing; + } + + public NoSuchUserException(Exception e) { + super(e); + } + + public List getMissing() { + return missing; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/RateLimitExceededException.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/RateLimitExceededException.java new file mode 100644 index 000000000..d08fe15bd --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/RateLimitExceededException.java @@ -0,0 +1,23 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + +public class RateLimitExceededException extends Exception { + public RateLimitExceededException(String number) { + super(number); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/controllers/ValidationException.java b/src/main/java/org/whispersystems/textsecuregcm/controllers/ValidationException.java new file mode 100644 index 000000000..e23a6bfaa --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/controllers/ValidationException.java @@ -0,0 +1,21 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.controllers; + + +public class ValidationException extends Exception { +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/AccountAttributes.java b/src/main/java/org/whispersystems/textsecuregcm/entities/AccountAttributes.java new file mode 100644 index 000000000..1d1d2aa7d --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/AccountAttributes.java @@ -0,0 +1,46 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class AccountAttributes { + + @JsonProperty + @NotEmpty + private String signalingKey; + + @JsonProperty + private boolean supportsSms; + + public AccountAttributes() {} + + public AccountAttributes(String signalingKey, boolean supportsSms) { + this.signalingKey = signalingKey; + this.supportsSms = supportsSms; + } + + public String getSignalingKey() { + return signalingKey; + } + + public boolean getSupportsSms() { + return supportsSms; + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/AccountCount.java b/src/main/java/org/whispersystems/textsecuregcm/entities/AccountCount.java new file mode 100644 index 000000000..b3220cd89 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/AccountCount.java @@ -0,0 +1,35 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public class AccountCount { + + @JsonProperty + private int count; + + public AccountCount(int count) { + this.count = count; + } + + public AccountCount() {} + + public int getCount() { + return count; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/ApnRegistrationId.java b/src/main/java/org/whispersystems/textsecuregcm/entities/ApnRegistrationId.java new file mode 100644 index 000000000..6057236fc --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/ApnRegistrationId.java @@ -0,0 +1,31 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class ApnRegistrationId { + + @JsonProperty + @NotEmpty + private String apnRegistrationId; + + public String getApnRegistrationId() { + return apnRegistrationId; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentDescriptor.java b/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentDescriptor.java new file mode 100644 index 000000000..038cfb825 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentDescriptor.java @@ -0,0 +1,43 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public class AttachmentDescriptor { + + @JsonProperty + private long id; + + @JsonProperty + private String location; + + public AttachmentDescriptor(long id, String location) { + this.id = id; + this.location = location; + } + + public AttachmentDescriptor() {} + + public long getId() { + return id; + } + + public String getLocation() { + return location; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentUri.java b/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentUri.java new file mode 100644 index 000000000..51dee6940 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/AttachmentUri.java @@ -0,0 +1,39 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URL; + +public class AttachmentUri { + + @JsonProperty + private String location; + + public AttachmentUri(URL uri) { + this.location = uri.toString(); + } + + public AttachmentUri() {} + + public URL getLocation() throws MalformedURLException { + return URI.create(location).toURL(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContact.java b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContact.java new file mode 100644 index 000000000..99ec3235c --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContact.java @@ -0,0 +1,98 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import com.google.gson.Gson; +import org.whispersystems.textsecuregcm.util.Base64; +import org.whispersystems.textsecuregcm.util.ByteArrayAdapter; + +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; +import java.util.Arrays; + +@JsonInclude(JsonInclude.Include.NON_DEFAULT) +public class ClientContact { + + @JsonSerialize(using = ByteArrayAdapter.Serializing.class) + @JsonDeserialize(using = ByteArrayAdapter.Deserializing.class) + @JsonProperty + private byte[] token; + + private String relay; + private boolean inactive; + private boolean supportsSms; + + public ClientContact(byte[] token, String relay, boolean supportsSms) { + this.token = token; + this.relay = relay; + this.supportsSms = supportsSms; + } + + public ClientContact() {} + + public byte[] getToken() { + return token; + } + + public String getRelay() { + return relay; + } + + public void setRelay(String relay) { + this.relay = relay; + } + + public boolean isSupportsSms() { + return supportsSms; + } + + public boolean isInactive() { + return inactive; + } + + public void setInactive(boolean inactive) { + this.inactive = inactive; + } + + public String toString() { + return new Gson().toJson(this); + } + + @Override + public boolean equals(Object other) { + if (other == null) return false; + if (!(other instanceof ClientContact)) return false; + + ClientContact that = (ClientContact)other; + + return + Arrays.equals(this.token, that.token) && + this.supportsSms == that.supportsSms && + this.inactive == that.inactive && + (this.relay == null ? (that.relay == null) : this.relay.equals(that.relay)); + } + + public int hashCode() { + return Arrays.hashCode(this.token); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContactTokens.java b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContactTokens.java new file mode 100644 index 000000000..81b55125f --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContactTokens.java @@ -0,0 +1,33 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import javax.validation.constraints.NotNull; +import java.util.List; + +public class ClientContactTokens { + + @NotNull + @JsonProperty + private List contacts; + + public List getContacts() { + return contacts; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContacts.java b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContacts.java new file mode 100644 index 000000000..cdf943b24 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/ClientContacts.java @@ -0,0 +1,41 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import java.util.LinkedList; +import java.util.List; + +public class ClientContacts { + + @JsonProperty + private List contacts; + + public ClientContacts(List contacts) { + if (contacts != null) this.contacts = contacts; + else this.contacts = new LinkedList<>(); + } + + public ClientContacts() { + this.contacts = new LinkedList<>(); + } + + public List getContacts() { + return contacts; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/EncryptedOutgoingMessage.java b/src/main/java/org/whispersystems/textsecuregcm/entities/EncryptedOutgoingMessage.java new file mode 100644 index 000000000..7c1e270aa --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/EncryptedOutgoingMessage.java @@ -0,0 +1,115 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal; +import org.whispersystems.textsecuregcm.util.Base64; +import org.whispersystems.textsecuregcm.util.Util; + +import javax.crypto.BadPaddingException; +import javax.crypto.Cipher; +import javax.crypto.IllegalBlockSizeException; +import javax.crypto.Mac; +import javax.crypto.NoSuchPaddingException; +import javax.crypto.spec.SecretKeySpec; +import java.io.IOException; +import java.security.InvalidKeyException; +import java.security.NoSuchAlgorithmException; + +public class EncryptedOutgoingMessage { + + private final Logger logger = LoggerFactory.getLogger(EncryptedOutgoingMessage.class); + + private static final byte[] VERSION = new byte[]{0x01}; + private static final int CIPHER_KEY_SIZE = 32; + private static final int MAC_KEY_SIZE = 20; + private static final int MAC_SIZE = 10; + + private final OutgoingMessageSignal outgoingMessage; + private final String signalingKey; + + public EncryptedOutgoingMessage(OutgoingMessageSignal outgoingMessage, + String signalingKey) + { + this.outgoingMessage = outgoingMessage; + this.signalingKey = signalingKey; + } + + public String serialize() throws IOException { + byte[] plaintext = outgoingMessage.toByteArray(); + SecretKeySpec cipherKey = getCipherKey (signalingKey); + SecretKeySpec macKey = getMacKey(signalingKey); + byte[] ciphertext = getCiphertext(plaintext, cipherKey, macKey); + + return Base64.encodeBytes(ciphertext); + } + + private byte[] getCiphertext(byte[] plaintext, SecretKeySpec cipherKey, SecretKeySpec macKey) + throws IOException + { + try { + Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding"); + cipher.init(Cipher.ENCRYPT_MODE, cipherKey); + + Mac hmac = Mac.getInstance("HmacSHA256"); + hmac.init(macKey); + + hmac.update(VERSION); + + byte[] ivBytes = cipher.getIV(); + hmac.update(ivBytes); + + byte[] ciphertext = cipher.doFinal(plaintext); + byte[] mac = hmac.doFinal(ciphertext); + byte[] truncatedMac = new byte[MAC_SIZE]; + System.arraycopy(mac, 0, truncatedMac, 0, truncatedMac.length); + + return Util.combine(VERSION, ivBytes, ciphertext, truncatedMac); + } catch (NoSuchAlgorithmException | NoSuchPaddingException | IllegalBlockSizeException | BadPaddingException e) { + throw new AssertionError(e); + } catch (InvalidKeyException e) { + logger.warn("Invalid Key", e); + throw new IOException("Invalid key!"); + } + } + + private SecretKeySpec getCipherKey(String signalingKey) throws IOException { + byte[] signalingKeyBytes = Base64.decode(signalingKey); + byte[] cipherKey = new byte[CIPHER_KEY_SIZE]; + + if (signalingKeyBytes.length < CIPHER_KEY_SIZE) + throw new IOException("Signaling key too short!"); + + System.arraycopy(signalingKeyBytes, 0, cipherKey, 0, cipherKey.length); + return new SecretKeySpec(cipherKey, "AES"); + } + + private SecretKeySpec getMacKey(String signalingKey) throws IOException { + byte[] signalingKeyBytes = Base64.decode(signalingKey); + byte[] macKey = new byte[MAC_KEY_SIZE]; + + if (signalingKeyBytes.length < CIPHER_KEY_SIZE + MAC_KEY_SIZE) + throw new IOException(("Signaling key too short!")); + + System.arraycopy(signalingKeyBytes, CIPHER_KEY_SIZE, macKey, 0, macKey.length); + + return new SecretKeySpec(macKey, "HmacSHA256"); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/GcmRegistrationId.java b/src/main/java/org/whispersystems/textsecuregcm/entities/GcmRegistrationId.java new file mode 100644 index 000000000..dc1dfec01 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/GcmRegistrationId.java @@ -0,0 +1,33 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class GcmRegistrationId { + + @JsonProperty + @NotEmpty + private String gcmRegistrationId; + + public String getGcmRegistrationId() { + return gcmRegistrationId; + } + +} + diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessage.java b/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessage.java new file mode 100644 index 000000000..f5cbfb5c2 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessage.java @@ -0,0 +1,56 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +public class IncomingMessage { + + @JsonProperty + private int type; + + @JsonProperty + @NotEmpty + private String destination; + + @JsonProperty + @NotEmpty + private String body; + + @JsonProperty + private String relay; + + @JsonProperty + private long timestamp; + + public String getDestination() { + return destination; + } + + public String getBody() { + return body; + } + + public int getType() { + return type; + } + + public String getRelay() { + return relay; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessageList.java b/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessageList.java new file mode 100644 index 000000000..c9e0cdd6a --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/IncomingMessageList.java @@ -0,0 +1,37 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import java.util.List; + +public class IncomingMessageList { + + @JsonProperty + @NotNull + @Valid + private List messages; + + public IncomingMessageList() {} + + public List getMessages() { + return messages; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/MessageProtos.java b/src/main/java/org/whispersystems/textsecuregcm/entities/MessageProtos.java new file mode 100644 index 000000000..60e63a559 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/MessageProtos.java @@ -0,0 +1,809 @@ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: OutgoingMessageSignal.proto + +package org.whispersystems.textsecuregcm.entities; + +public final class MessageProtos { + private MessageProtos() {} + public static void registerAllExtensions( + com.google.protobuf.ExtensionRegistry registry) { + } + public interface OutgoingMessageSignalOrBuilder + extends com.google.protobuf.MessageOrBuilder { + + // optional uint32 type = 1; + boolean hasType(); + int getType(); + + // optional string source = 2; + boolean hasSource(); + String getSource(); + + // optional string relay = 3; + boolean hasRelay(); + String getRelay(); + + // repeated string destinations = 4; + java.util.List getDestinationsList(); + int getDestinationsCount(); + String getDestinations(int index); + + // optional uint64 timestamp = 5; + boolean hasTimestamp(); + long getTimestamp(); + + // optional bytes message = 6; + boolean hasMessage(); + com.google.protobuf.ByteString getMessage(); + } + public static final class OutgoingMessageSignal extends + com.google.protobuf.GeneratedMessage + implements OutgoingMessageSignalOrBuilder { + // Use OutgoingMessageSignal.newBuilder() to construct. + private OutgoingMessageSignal(Builder builder) { + super(builder); + } + private OutgoingMessageSignal(boolean noInit) {} + + private static final OutgoingMessageSignal defaultInstance; + public static OutgoingMessageSignal getDefaultInstance() { + return defaultInstance; + } + + public OutgoingMessageSignal getDefaultInstanceForType() { + return defaultInstance; + } + + public static final com.google.protobuf.Descriptors.Descriptor + getDescriptor() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.internal_static_textsecure_OutgoingMessageSignal_descriptor; + } + + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.internal_static_textsecure_OutgoingMessageSignal_fieldAccessorTable; + } + + private int bitField0_; + // optional uint32 type = 1; + public static final int TYPE_FIELD_NUMBER = 1; + private int type_; + public boolean hasType() { + return ((bitField0_ & 0x00000001) == 0x00000001); + } + public int getType() { + return type_; + } + + // optional string source = 2; + public static final int SOURCE_FIELD_NUMBER = 2; + private java.lang.Object source_; + public boolean hasSource() { + return ((bitField0_ & 0x00000002) == 0x00000002); + } + public String getSource() { + java.lang.Object ref = source_; + if (ref instanceof String) { + return (String) ref; + } else { + com.google.protobuf.ByteString bs = + (com.google.protobuf.ByteString) ref; + String s = bs.toStringUtf8(); + if (com.google.protobuf.Internal.isValidUtf8(bs)) { + source_ = s; + } + return s; + } + } + private com.google.protobuf.ByteString getSourceBytes() { + java.lang.Object ref = source_; + if (ref instanceof String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((String) ref); + source_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + + // optional string relay = 3; + public static final int RELAY_FIELD_NUMBER = 3; + private java.lang.Object relay_; + public boolean hasRelay() { + return ((bitField0_ & 0x00000004) == 0x00000004); + } + public String getRelay() { + java.lang.Object ref = relay_; + if (ref instanceof String) { + return (String) ref; + } else { + com.google.protobuf.ByteString bs = + (com.google.protobuf.ByteString) ref; + String s = bs.toStringUtf8(); + if (com.google.protobuf.Internal.isValidUtf8(bs)) { + relay_ = s; + } + return s; + } + } + private com.google.protobuf.ByteString getRelayBytes() { + java.lang.Object ref = relay_; + if (ref instanceof String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((String) ref); + relay_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + + // repeated string destinations = 4; + public static final int DESTINATIONS_FIELD_NUMBER = 4; + private com.google.protobuf.LazyStringList destinations_; + public java.util.List + getDestinationsList() { + return destinations_; + } + public int getDestinationsCount() { + return destinations_.size(); + } + public String getDestinations(int index) { + return destinations_.get(index); + } + + // optional uint64 timestamp = 5; + public static final int TIMESTAMP_FIELD_NUMBER = 5; + private long timestamp_; + public boolean hasTimestamp() { + return ((bitField0_ & 0x00000008) == 0x00000008); + } + public long getTimestamp() { + return timestamp_; + } + + // optional bytes message = 6; + public static final int MESSAGE_FIELD_NUMBER = 6; + private com.google.protobuf.ByteString message_; + public boolean hasMessage() { + return ((bitField0_ & 0x00000010) == 0x00000010); + } + public com.google.protobuf.ByteString getMessage() { + return message_; + } + + private void initFields() { + type_ = 0; + source_ = ""; + relay_ = ""; + destinations_ = com.google.protobuf.LazyStringArrayList.EMPTY; + timestamp_ = 0L; + message_ = com.google.protobuf.ByteString.EMPTY; + } + private byte memoizedIsInitialized = -1; + public final boolean isInitialized() { + byte isInitialized = memoizedIsInitialized; + if (isInitialized != -1) return isInitialized == 1; + + memoizedIsInitialized = 1; + return true; + } + + public void writeTo(com.google.protobuf.CodedOutputStream output) + throws java.io.IOException { + getSerializedSize(); + if (((bitField0_ & 0x00000001) == 0x00000001)) { + output.writeUInt32(1, type_); + } + if (((bitField0_ & 0x00000002) == 0x00000002)) { + output.writeBytes(2, getSourceBytes()); + } + if (((bitField0_ & 0x00000004) == 0x00000004)) { + output.writeBytes(3, getRelayBytes()); + } + for (int i = 0; i < destinations_.size(); i++) { + output.writeBytes(4, destinations_.getByteString(i)); + } + if (((bitField0_ & 0x00000008) == 0x00000008)) { + output.writeUInt64(5, timestamp_); + } + if (((bitField0_ & 0x00000010) == 0x00000010)) { + output.writeBytes(6, message_); + } + getUnknownFields().writeTo(output); + } + + private int memoizedSerializedSize = -1; + public int getSerializedSize() { + int size = memoizedSerializedSize; + if (size != -1) return size; + + size = 0; + if (((bitField0_ & 0x00000001) == 0x00000001)) { + size += com.google.protobuf.CodedOutputStream + .computeUInt32Size(1, type_); + } + if (((bitField0_ & 0x00000002) == 0x00000002)) { + size += com.google.protobuf.CodedOutputStream + .computeBytesSize(2, getSourceBytes()); + } + if (((bitField0_ & 0x00000004) == 0x00000004)) { + size += com.google.protobuf.CodedOutputStream + .computeBytesSize(3, getRelayBytes()); + } + { + int dataSize = 0; + for (int i = 0; i < destinations_.size(); i++) { + dataSize += com.google.protobuf.CodedOutputStream + .computeBytesSizeNoTag(destinations_.getByteString(i)); + } + size += dataSize; + size += 1 * getDestinationsList().size(); + } + if (((bitField0_ & 0x00000008) == 0x00000008)) { + size += com.google.protobuf.CodedOutputStream + .computeUInt64Size(5, timestamp_); + } + if (((bitField0_ & 0x00000010) == 0x00000010)) { + size += com.google.protobuf.CodedOutputStream + .computeBytesSize(6, message_); + } + size += getUnknownFields().getSerializedSize(); + memoizedSerializedSize = size; + return size; + } + + private static final long serialVersionUID = 0L; + @java.lang.Override + protected java.lang.Object writeReplace() + throws java.io.ObjectStreamException { + return super.writeReplace(); + } + + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException { + return newBuilder().mergeFrom(data).buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return newBuilder().mergeFrom(data, extensionRegistry) + .buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom(byte[] data) + throws com.google.protobuf.InvalidProtocolBufferException { + return newBuilder().mergeFrom(data).buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + byte[] data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return newBuilder().mergeFrom(data, extensionRegistry) + .buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom(java.io.InputStream input) + throws java.io.IOException { + return newBuilder().mergeFrom(input).buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + java.io.InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return newBuilder().mergeFrom(input, extensionRegistry) + .buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseDelimitedFrom(java.io.InputStream input) + throws java.io.IOException { + Builder builder = newBuilder(); + if (builder.mergeDelimitedFrom(input)) { + return builder.buildParsed(); + } else { + return null; + } + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseDelimitedFrom( + java.io.InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + Builder builder = newBuilder(); + if (builder.mergeDelimitedFrom(input, extensionRegistry)) { + return builder.buildParsed(); + } else { + return null; + } + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + com.google.protobuf.CodedInputStream input) + throws java.io.IOException { + return newBuilder().mergeFrom(input).buildParsed(); + } + public static org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal parseFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return newBuilder().mergeFrom(input, extensionRegistry) + .buildParsed(); + } + + public static Builder newBuilder() { return Builder.create(); } + public Builder newBuilderForType() { return newBuilder(); } + public static Builder newBuilder(org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal prototype) { + return newBuilder().mergeFrom(prototype); + } + public Builder toBuilder() { return newBuilder(this); } + + @java.lang.Override + protected Builder newBuilderForType( + com.google.protobuf.GeneratedMessage.BuilderParent parent) { + Builder builder = new Builder(parent); + return builder; + } + public static final class Builder extends + com.google.protobuf.GeneratedMessage.Builder + implements org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignalOrBuilder { + public static final com.google.protobuf.Descriptors.Descriptor + getDescriptor() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.internal_static_textsecure_OutgoingMessageSignal_descriptor; + } + + protected com.google.protobuf.GeneratedMessage.FieldAccessorTable + internalGetFieldAccessorTable() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.internal_static_textsecure_OutgoingMessageSignal_fieldAccessorTable; + } + + // Construct using org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.newBuilder() + private Builder() { + maybeForceBuilderInitialization(); + } + + private Builder(BuilderParent parent) { + super(parent); + maybeForceBuilderInitialization(); + } + private void maybeForceBuilderInitialization() { + if (com.google.protobuf.GeneratedMessage.alwaysUseFieldBuilders) { + } + } + private static Builder create() { + return new Builder(); + } + + public Builder clear() { + super.clear(); + type_ = 0; + bitField0_ = (bitField0_ & ~0x00000001); + source_ = ""; + bitField0_ = (bitField0_ & ~0x00000002); + relay_ = ""; + bitField0_ = (bitField0_ & ~0x00000004); + destinations_ = com.google.protobuf.LazyStringArrayList.EMPTY; + bitField0_ = (bitField0_ & ~0x00000008); + timestamp_ = 0L; + bitField0_ = (bitField0_ & ~0x00000010); + message_ = com.google.protobuf.ByteString.EMPTY; + bitField0_ = (bitField0_ & ~0x00000020); + return this; + } + + public Builder clone() { + return create().mergeFrom(buildPartial()); + } + + public com.google.protobuf.Descriptors.Descriptor + getDescriptorForType() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.getDescriptor(); + } + + public org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal getDefaultInstanceForType() { + return org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.getDefaultInstance(); + } + + public org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal build() { + org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal result = buildPartial(); + if (!result.isInitialized()) { + throw newUninitializedMessageException(result); + } + return result; + } + + private org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal buildParsed() + throws com.google.protobuf.InvalidProtocolBufferException { + org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal result = buildPartial(); + if (!result.isInitialized()) { + throw newUninitializedMessageException( + result).asInvalidProtocolBufferException(); + } + return result; + } + + public org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal buildPartial() { + org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal result = new org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal(this); + int from_bitField0_ = bitField0_; + int to_bitField0_ = 0; + if (((from_bitField0_ & 0x00000001) == 0x00000001)) { + to_bitField0_ |= 0x00000001; + } + result.type_ = type_; + if (((from_bitField0_ & 0x00000002) == 0x00000002)) { + to_bitField0_ |= 0x00000002; + } + result.source_ = source_; + if (((from_bitField0_ & 0x00000004) == 0x00000004)) { + to_bitField0_ |= 0x00000004; + } + result.relay_ = relay_; + if (((bitField0_ & 0x00000008) == 0x00000008)) { + destinations_ = new com.google.protobuf.UnmodifiableLazyStringList( + destinations_); + bitField0_ = (bitField0_ & ~0x00000008); + } + result.destinations_ = destinations_; + if (((from_bitField0_ & 0x00000010) == 0x00000010)) { + to_bitField0_ |= 0x00000008; + } + result.timestamp_ = timestamp_; + if (((from_bitField0_ & 0x00000020) == 0x00000020)) { + to_bitField0_ |= 0x00000010; + } + result.message_ = message_; + result.bitField0_ = to_bitField0_; + onBuilt(); + return result; + } + + public Builder mergeFrom(com.google.protobuf.Message other) { + if (other instanceof org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal) { + return mergeFrom((org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal)other); + } else { + super.mergeFrom(other); + return this; + } + } + + public Builder mergeFrom(org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal other) { + if (other == org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.getDefaultInstance()) return this; + if (other.hasType()) { + setType(other.getType()); + } + if (other.hasSource()) { + setSource(other.getSource()); + } + if (other.hasRelay()) { + setRelay(other.getRelay()); + } + if (!other.destinations_.isEmpty()) { + if (destinations_.isEmpty()) { + destinations_ = other.destinations_; + bitField0_ = (bitField0_ & ~0x00000008); + } else { + ensureDestinationsIsMutable(); + destinations_.addAll(other.destinations_); + } + onChanged(); + } + if (other.hasTimestamp()) { + setTimestamp(other.getTimestamp()); + } + if (other.hasMessage()) { + setMessage(other.getMessage()); + } + this.mergeUnknownFields(other.getUnknownFields()); + return this; + } + + public final boolean isInitialized() { + return true; + } + + public Builder mergeFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + com.google.protobuf.UnknownFieldSet.Builder unknownFields = + com.google.protobuf.UnknownFieldSet.newBuilder( + this.getUnknownFields()); + while (true) { + int tag = input.readTag(); + switch (tag) { + case 0: + this.setUnknownFields(unknownFields.build()); + onChanged(); + return this; + default: { + if (!parseUnknownField(input, unknownFields, + extensionRegistry, tag)) { + this.setUnknownFields(unknownFields.build()); + onChanged(); + return this; + } + break; + } + case 8: { + bitField0_ |= 0x00000001; + type_ = input.readUInt32(); + break; + } + case 18: { + bitField0_ |= 0x00000002; + source_ = input.readBytes(); + break; + } + case 26: { + bitField0_ |= 0x00000004; + relay_ = input.readBytes(); + break; + } + case 34: { + ensureDestinationsIsMutable(); + destinations_.add(input.readBytes()); + break; + } + case 40: { + bitField0_ |= 0x00000010; + timestamp_ = input.readUInt64(); + break; + } + case 50: { + bitField0_ |= 0x00000020; + message_ = input.readBytes(); + break; + } + } + } + } + + private int bitField0_; + + // optional uint32 type = 1; + private int type_ ; + public boolean hasType() { + return ((bitField0_ & 0x00000001) == 0x00000001); + } + public int getType() { + return type_; + } + public Builder setType(int value) { + bitField0_ |= 0x00000001; + type_ = value; + onChanged(); + return this; + } + public Builder clearType() { + bitField0_ = (bitField0_ & ~0x00000001); + type_ = 0; + onChanged(); + return this; + } + + // optional string source = 2; + private java.lang.Object source_ = ""; + public boolean hasSource() { + return ((bitField0_ & 0x00000002) == 0x00000002); + } + public String getSource() { + java.lang.Object ref = source_; + if (!(ref instanceof String)) { + String s = ((com.google.protobuf.ByteString) ref).toStringUtf8(); + source_ = s; + return s; + } else { + return (String) ref; + } + } + public Builder setSource(String value) { + if (value == null) { + throw new NullPointerException(); + } + bitField0_ |= 0x00000002; + source_ = value; + onChanged(); + return this; + } + public Builder clearSource() { + bitField0_ = (bitField0_ & ~0x00000002); + source_ = getDefaultInstance().getSource(); + onChanged(); + return this; + } + void setSource(com.google.protobuf.ByteString value) { + bitField0_ |= 0x00000002; + source_ = value; + onChanged(); + } + + // optional string relay = 3; + private java.lang.Object relay_ = ""; + public boolean hasRelay() { + return ((bitField0_ & 0x00000004) == 0x00000004); + } + public String getRelay() { + java.lang.Object ref = relay_; + if (!(ref instanceof String)) { + String s = ((com.google.protobuf.ByteString) ref).toStringUtf8(); + relay_ = s; + return s; + } else { + return (String) ref; + } + } + public Builder setRelay(String value) { + if (value == null) { + throw new NullPointerException(); + } + bitField0_ |= 0x00000004; + relay_ = value; + onChanged(); + return this; + } + public Builder clearRelay() { + bitField0_ = (bitField0_ & ~0x00000004); + relay_ = getDefaultInstance().getRelay(); + onChanged(); + return this; + } + void setRelay(com.google.protobuf.ByteString value) { + bitField0_ |= 0x00000004; + relay_ = value; + onChanged(); + } + + // repeated string destinations = 4; + private com.google.protobuf.LazyStringList destinations_ = com.google.protobuf.LazyStringArrayList.EMPTY; + private void ensureDestinationsIsMutable() { + if (!((bitField0_ & 0x00000008) == 0x00000008)) { + destinations_ = new com.google.protobuf.LazyStringArrayList(destinations_); + bitField0_ |= 0x00000008; + } + } + public java.util.List + getDestinationsList() { + return java.util.Collections.unmodifiableList(destinations_); + } + public int getDestinationsCount() { + return destinations_.size(); + } + public String getDestinations(int index) { + return destinations_.get(index); + } + public Builder setDestinations( + int index, String value) { + if (value == null) { + throw new NullPointerException(); + } + ensureDestinationsIsMutable(); + destinations_.set(index, value); + onChanged(); + return this; + } + public Builder addDestinations(String value) { + if (value == null) { + throw new NullPointerException(); + } + ensureDestinationsIsMutable(); + destinations_.add(value); + onChanged(); + return this; + } + public Builder addAllDestinations( + java.lang.Iterable values) { + ensureDestinationsIsMutable(); + super.addAll(values, destinations_); + onChanged(); + return this; + } + public Builder clearDestinations() { + destinations_ = com.google.protobuf.LazyStringArrayList.EMPTY; + bitField0_ = (bitField0_ & ~0x00000008); + onChanged(); + return this; + } + void addDestinations(com.google.protobuf.ByteString value) { + ensureDestinationsIsMutable(); + destinations_.add(value); + onChanged(); + } + + // optional uint64 timestamp = 5; + private long timestamp_ ; + public boolean hasTimestamp() { + return ((bitField0_ & 0x00000010) == 0x00000010); + } + public long getTimestamp() { + return timestamp_; + } + public Builder setTimestamp(long value) { + bitField0_ |= 0x00000010; + timestamp_ = value; + onChanged(); + return this; + } + public Builder clearTimestamp() { + bitField0_ = (bitField0_ & ~0x00000010); + timestamp_ = 0L; + onChanged(); + return this; + } + + // optional bytes message = 6; + private com.google.protobuf.ByteString message_ = com.google.protobuf.ByteString.EMPTY; + public boolean hasMessage() { + return ((bitField0_ & 0x00000020) == 0x00000020); + } + public com.google.protobuf.ByteString getMessage() { + return message_; + } + public Builder setMessage(com.google.protobuf.ByteString value) { + if (value == null) { + throw new NullPointerException(); + } + bitField0_ |= 0x00000020; + message_ = value; + onChanged(); + return this; + } + public Builder clearMessage() { + bitField0_ = (bitField0_ & ~0x00000020); + message_ = getDefaultInstance().getMessage(); + onChanged(); + return this; + } + + // @@protoc_insertion_point(builder_scope:textsecure.OutgoingMessageSignal) + } + + static { + defaultInstance = new OutgoingMessageSignal(true); + defaultInstance.initFields(); + } + + // @@protoc_insertion_point(class_scope:textsecure.OutgoingMessageSignal) + } + + private static com.google.protobuf.Descriptors.Descriptor + internal_static_textsecure_OutgoingMessageSignal_descriptor; + private static + com.google.protobuf.GeneratedMessage.FieldAccessorTable + internal_static_textsecure_OutgoingMessageSignal_fieldAccessorTable; + + public static com.google.protobuf.Descriptors.FileDescriptor + getDescriptor() { + return descriptor; + } + private static com.google.protobuf.Descriptors.FileDescriptor + descriptor; + static { + java.lang.String[] descriptorData = { + "\n\033OutgoingMessageSignal.proto\022\ntextsecur" + + "e\"~\n\025OutgoingMessageSignal\022\014\n\004type\030\001 \001(\r" + + "\022\016\n\006source\030\002 \001(\t\022\r\n\005relay\030\003 \001(\t\022\024\n\014desti" + + "nations\030\004 \003(\t\022\021\n\ttimestamp\030\005 \001(\004\022\017\n\007mess" + + "age\030\006 \001(\014B:\n)org.whispersystems.textsecu" + + "regcm.entitiesB\rMessageProtos" + }; + com.google.protobuf.Descriptors.FileDescriptor.InternalDescriptorAssigner assigner = + new com.google.protobuf.Descriptors.FileDescriptor.InternalDescriptorAssigner() { + public com.google.protobuf.ExtensionRegistry assignDescriptors( + com.google.protobuf.Descriptors.FileDescriptor root) { + descriptor = root; + internal_static_textsecure_OutgoingMessageSignal_descriptor = + getDescriptor().getMessageTypes().get(0); + internal_static_textsecure_OutgoingMessageSignal_fieldAccessorTable = new + com.google.protobuf.GeneratedMessage.FieldAccessorTable( + internal_static_textsecure_OutgoingMessageSignal_descriptor, + new java.lang.String[] { "Type", "Source", "Relay", "Destinations", "Timestamp", "Message", }, + org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.class, + org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal.Builder.class); + return null; + } + }; + com.google.protobuf.Descriptors.FileDescriptor + .internalBuildGeneratedFileFrom(descriptorData, + new com.google.protobuf.Descriptors.FileDescriptor[] { + }, assigner); + } + + // @@protoc_insertion_point(outer_class_scope) +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/MessageResponse.java b/src/main/java/org/whispersystems/textsecuregcm/entities/MessageResponse.java new file mode 100644 index 000000000..a04e96f10 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/MessageResponse.java @@ -0,0 +1,40 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import java.util.List; + +public class MessageResponse { + private List success; + private List failure; + + public MessageResponse(List success, List failure) { + this.success = success; + this.failure = failure; + } + + public MessageResponse() {} + + public List getSuccess() { + return success; + } + + public List getFailure() { + return failure; + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/PreKey.java b/src/main/java/org/whispersystems/textsecuregcm/entities/PreKey.java new file mode 100644 index 000000000..69a0cae56 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/PreKey.java @@ -0,0 +1,116 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + + +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; + +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.XmlTransient; +import java.io.Serializable; + +@JsonInclude(JsonInclude.Include.NON_DEFAULT) +public class PreKey { + + @JsonIgnore + private long id; + + @JsonIgnore + private String number; + + @JsonProperty + @NotNull + private long keyId; + + @JsonProperty + @NotNull + private String publicKey; + + @JsonProperty + @NotNull + private String identityKey; + + @JsonProperty + private boolean lastResort; + + public PreKey() {} + + public PreKey(long id, String number, long keyId, + String publicKey, String identityKey, + boolean lastResort) + { + this.id = id; + this.number = number; + this.keyId = keyId; + this.publicKey = publicKey; + this.identityKey = identityKey; + this.lastResort = lastResort; + } + + @XmlTransient + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + @XmlTransient + public String getNumber() { + return number; + } + + public void setNumber(String number) { + this.number = number; + } + + public String getPublicKey() { + return publicKey; + } + + public void setPublicKey(String publicKey) { + this.publicKey = publicKey; + } + + public long getKeyId() { + return keyId; + } + + public void setKeyId(long keyId) { + this.keyId = keyId; + } + + public String getIdentityKey() { + return identityKey; + } + + public void setIdentityKey(String identityKey) { + this.identityKey = identityKey; + } + + @XmlTransient + public boolean isLastResort() { + return lastResort; + } + + public void setLastResort(boolean lastResort) { + this.lastResort = lastResort; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/PreKeyList.java b/src/main/java/org/whispersystems/textsecuregcm/entities/PreKeyList.java new file mode 100644 index 000000000..49e0ea7cd --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/PreKeyList.java @@ -0,0 +1,44 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; + +import javax.validation.Valid; +import javax.validation.constraints.NotNull; +import java.util.List; + +public class PreKeyList { + + @JsonProperty + @NotNull + private PreKey lastResortKey; + + @JsonProperty + @NotNull + @Valid + private List keys; + + public List getKeys() { + return keys; + } + + public PreKey getLastResortKey() { + return lastResortKey; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/entities/RelayMessage.java b/src/main/java/org/whispersystems/textsecuregcm/entities/RelayMessage.java new file mode 100644 index 000000000..4a8ccb2f8 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/entities/RelayMessage.java @@ -0,0 +1,55 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.entities; + + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.annotation.JsonSerialize; +import org.hibernate.validator.constraints.NotEmpty; +import org.whispersystems.textsecuregcm.util.ByteArrayAdapter; + +import javax.validation.constraints.NotNull; +import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; + +public class RelayMessage { + + @JsonProperty + @NotEmpty + private String destination; + + @JsonProperty + @NotNull + @JsonSerialize(using = ByteArrayAdapter.Serializing.class) + @JsonDeserialize(using = ByteArrayAdapter.Deserializing.class) + private byte[] outgoingMessageSignal; + + public RelayMessage() {} + + public RelayMessage(String destination, byte[] outgoingMessageSignal) { + this.destination = destination; + this.outgoingMessageSignal = outgoingMessageSignal; + } + + public String getDestination() { + return destination; + } + + public byte[] getOutgoingMessageSignal() { + return outgoingMessageSignal; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClient.java b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClient.java new file mode 100644 index 000000000..19a75a132 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClient.java @@ -0,0 +1,212 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.federation; + + +import com.sun.jersey.api.client.Client; +import com.sun.jersey.api.client.ClientHandlerException; +import com.sun.jersey.api.client.ClientResponse; +import com.sun.jersey.api.client.UniformInterfaceException; +import com.sun.jersey.api.client.WebResource; +import com.sun.jersey.api.client.config.ClientConfig; +import com.sun.jersey.api.client.config.DefaultClientConfig; +import com.sun.jersey.api.json.JSONConfiguration; +import com.sun.jersey.client.urlconnection.HTTPSProperties; +import org.apache.http.conn.ssl.StrictHostnameVerifier; +import org.bouncycastle.openssl.PEMReader; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.controllers.NoSuchUserException; +import org.whispersystems.textsecuregcm.entities.AccountCount; +import org.whispersystems.textsecuregcm.entities.AttachmentUri; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.entities.ClientContacts; +import org.whispersystems.textsecuregcm.entities.MessageProtos.OutgoingMessageSignal; +import org.whispersystems.textsecuregcm.entities.PreKey; +import org.whispersystems.textsecuregcm.entities.RelayMessage; +import org.whispersystems.textsecuregcm.util.Base64; + +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManagerFactory; +import javax.ws.rs.core.MediaType; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URL; +import java.security.KeyManagementException; +import java.security.KeyStore; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; +import java.util.List; + +public class FederatedClient { + + private final Logger logger = LoggerFactory.getLogger(FederatedClient.class); + + private static final String USER_COUNT_PATH = "/v1/federation/user_count"; + private static final String USER_TOKENS_PATH = "/v1/federation/user_tokens/%d"; + private static final String RELAY_MESSAGE_PATH = "/v1/federation/message"; + private static final String PREKEY_PATH = "/v1/federation/key/%s"; + private static final String ATTACHMENT_URI_PATH = "/v1/federation/attachment/%d"; + + private final FederatedPeer peer; + private final Client client; + private final String authorizationHeader; + + public FederatedClient(String federationName, FederatedPeer peer) + throws IOException + { + try { + this.client = Client.create(getClientConfig(peer)); + this.peer = peer; + this.authorizationHeader = getAuthorizationHeader(federationName, peer); + } catch (NoSuchAlgorithmException e) { + throw new AssertionError(e); + } catch (KeyStoreException | KeyManagementException | CertificateException e) { + throw new IOException(e); + } + } + + public URL getSignedAttachmentUri(long attachmentId) throws IOException { + try { + WebResource resource = client.resource(peer.getUrl()) + .path(String.format(ATTACHMENT_URI_PATH, attachmentId)); + + return resource.accept(MediaType.APPLICATION_JSON) + .header("Authorization", authorizationHeader) + .get(AttachmentUri.class) + .getLocation(); + } catch (UniformInterfaceException | ClientHandlerException e) { + logger.warn("Bad URI", e); + throw new IOException(e); + } + } + + public PreKey getKey(String destination) { + try { + WebResource resource = client.resource(peer.getUrl()).path(String.format(PREKEY_PATH, destination)); + return resource.accept(MediaType.APPLICATION_JSON) + .header("Authorization", authorizationHeader) + .get(PreKey.class); + } catch (UniformInterfaceException | ClientHandlerException e) { + logger.warn("PreKey", e); + return null; + } + } + + public int getUserCount() { + try { + WebResource resource = client.resource(peer.getUrl()).path(USER_COUNT_PATH); + AccountCount count = resource.accept(MediaType.APPLICATION_JSON) + .header("Authorization", authorizationHeader) + .get(AccountCount.class); + + return count.getCount(); + } catch (UniformInterfaceException | ClientHandlerException e) { + logger.warn("User Count", e); + return 0; + } + } + + public List getUserTokens(int offset) { + try { + WebResource resource = client.resource(peer.getUrl()).path(String.format(USER_TOKENS_PATH, offset)); + ClientContacts contacts = resource.accept(MediaType.APPLICATION_JSON) + .header("Authorization", authorizationHeader) + .get(ClientContacts.class); + + return contacts.getContacts(); + } catch (UniformInterfaceException | ClientHandlerException e) { + logger.warn("User Tokens", e); + return null; + } + } + + public void sendMessage(String destination, OutgoingMessageSignal message) + throws IOException, NoSuchUserException + { + try { + WebResource resource = client.resource(peer.getUrl()).path(RELAY_MESSAGE_PATH); + ClientResponse response = resource.type(MediaType.APPLICATION_JSON) + .header("Authorization", authorizationHeader) + .entity(new RelayMessage(destination, message.toByteArray())) + .put(ClientResponse.class); + + if (response.getStatus() == 404) { + throw new NoSuchUserException("No remote user: " + destination); + } + + if (response.getStatus() != 200 && response.getStatus() != 204) { + throw new IOException("Bad response: " + response.getStatus()); + } + } catch (UniformInterfaceException | ClientHandlerException e) { + logger.warn("sendMessage", e); + throw new IOException(e); + } + } + + private String getAuthorizationHeader(String federationName, FederatedPeer peer) { + return "Basic " + Base64.encodeBytes((federationName + ":" + peer.getAuthenticationToken()).getBytes()); + } + + private ClientConfig getClientConfig(FederatedPeer peer) + throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException, CertificateException + { + TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance("X509"); + trustManagerFactory.init(initializeTrustStore(peer.getName(), peer.getCertificate())); + + SSLContext sslContext = SSLContext.getInstance("TLS"); + sslContext.init(null, trustManagerFactory.getTrustManagers(), SecureRandom.getInstance("SHA1PRNG")); + + ClientConfig config = new DefaultClientConfig(); + config.getProperties().put(HTTPSProperties.PROPERTY_HTTPS_PROPERTIES, + new HTTPSProperties(new StrictHostnameVerifier(), sslContext)); + config.getFeatures().put(JSONConfiguration.FEATURE_POJO_MAPPING, Boolean.TRUE); + + return config; + } + + private KeyStore initializeTrustStore(String name, String pemCertificate) + throws CertificateException + { + try { + PEMReader reader = new PEMReader(new InputStreamReader(new ByteArrayInputStream(pemCertificate.getBytes()))); + X509Certificate certificate = (X509Certificate) reader.readObject(); + + if (certificate == null) { + throw new CertificateException("No certificate found in parsing!"); + } + + KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); + keyStore.load(null); + keyStore.setCertificateEntry(name, certificate); + + return keyStore; + } catch (IOException | KeyStoreException e) { + throw new CertificateException(e); + } catch (NoSuchAlgorithmException e) { + throw new AssertionError(e); + } + } + + public String getPeerName() { + return peer.getName(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClientManager.java b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClientManager.java new file mode 100644 index 000000000..efca6649b --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedClientManager.java @@ -0,0 +1,62 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.federation; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.configuration.FederationConfiguration; + +import java.io.IOException; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.List; + +public class FederatedClientManager { + + private final Logger logger = LoggerFactory.getLogger(FederatedClientManager.class); + + private final HashMap clients = new HashMap<>(); + + public FederatedClientManager(FederationConfiguration federationConfig) + throws IOException + { + List peers = federationConfig.getPeers(); + String identity = federationConfig.getName(); + + if (peers != null) { + for (FederatedPeer peer : peers) { + logger.info("Adding peer: " + peer.getName()); + clients.put(peer.getName(), new FederatedClient(identity, peer)); + } + } + } + + public FederatedClient getClient(String name) throws NoSuchPeerException { + FederatedClient client = clients.get(name); + + if (client == null) { + throw new NoSuchPeerException(name); + } + + return client; + } + + public List getClients() { + return new LinkedList<>(clients.values()); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedPeer.java b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedPeer.java new file mode 100644 index 000000000..197820638 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/federation/FederatedPeer.java @@ -0,0 +1,66 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.federation; + +import com.fasterxml.jackson.annotation.JsonProperty; +import org.hibernate.validator.constraints.NotEmpty; +import org.hibernate.validator.constraints.URL; + +public class FederatedPeer { + + @NotEmpty + @JsonProperty + private String name; + + @NotEmpty + @URL + @JsonProperty + private String url; + + @NotEmpty + @JsonProperty + private String authenticationToken; + + @NotEmpty + @JsonProperty + private String certificate; + + public FederatedPeer() {} + + public FederatedPeer(String name, String url, String authenticationToken, String certificate) { + this.name = name; + this.url = url; + this.authenticationToken = authenticationToken; + this.certificate = certificate; + } + + public String getUrl() { + return url; + } + + public String getName() { + return name; + } + + public String getAuthenticationToken() { + return authenticationToken; + } + + public String getCertificate() { + return certificate; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/federation/NoSuchPeerException.java b/src/main/java/org/whispersystems/textsecuregcm/federation/NoSuchPeerException.java new file mode 100644 index 000000000..ad23809ba --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/federation/NoSuchPeerException.java @@ -0,0 +1,24 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.federation; + + +public class NoSuchPeerException extends Exception { + public NoSuchPeerException(String name) { + super(name); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/limits/LeakyBucket.java b/src/main/java/org/whispersystems/textsecuregcm/limits/LeakyBucket.java new file mode 100644 index 000000000..61389d118 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/limits/LeakyBucket.java @@ -0,0 +1,53 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.limits; + +import java.io.Serializable; + +public class LeakyBucket implements Serializable { + + private final int bucketSize; + private final double leakRatePerMillis; + + private int spaceRemaining; + private long lastUpdateTimeMillis; + + public LeakyBucket(int bucketSize, double leakRatePerMillis) { + this.bucketSize = bucketSize; + this.leakRatePerMillis = leakRatePerMillis; + this.spaceRemaining = bucketSize; + this.lastUpdateTimeMillis = System.currentTimeMillis(); + } + + public boolean add(int amount) { + this.spaceRemaining = getUpdatedSpaceRemaining(); + + if (this.spaceRemaining >= amount) { + this.spaceRemaining -= amount; + return true; + } else { + return false; + } + } + + private int getUpdatedSpaceRemaining() { + long elapsedTime = System.currentTimeMillis() - this.lastUpdateTimeMillis; + + return Math.min(this.bucketSize, + (int)Math.floor(this.spaceRemaining + (elapsedTime * this.leakRatePerMillis))); + } +} \ No newline at end of file diff --git a/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiter.java b/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiter.java new file mode 100644 index 000000000..3309e5534 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiter.java @@ -0,0 +1,78 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.limits; + +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import net.spy.memcached.MemcachedClient; + +import org.whispersystems.textsecuregcm.controllers.RateLimitExceededException; + +import java.util.concurrent.TimeUnit; + +public class RateLimiter { + + private final Meter meter; + private final MemcachedClient memcachedClient; + private final String name; + private final int bucketSize; + private final double leakRatePerMillis; + + public RateLimiter(MemcachedClient memcachedClient, String name, + int bucketSize, double leakRatePerMinute) + { + this.meter = Metrics.newMeter(RateLimiter.class, name, "exceeded", TimeUnit.MINUTES); + this.memcachedClient = memcachedClient; + this.name = name; + this.bucketSize = bucketSize; + this.leakRatePerMillis = leakRatePerMinute / (60.0 * 1000.0); + } + + public void validate(String key, int amount) throws RateLimitExceededException { + LeakyBucket bucket = getBucket(key); + + if (bucket.add(amount)) { + setBucket(key, bucket); + } else { + meter.mark(); + throw new RateLimitExceededException(key + " , " + amount); + } + } + + public void validate(String key) throws RateLimitExceededException { + validate(key, 1); + } + + private void setBucket(String key, LeakyBucket bucket) { + memcachedClient.set(getBucketName(key), + (int)Math.ceil((bucketSize / leakRatePerMillis) / 1000), bucket); + } + + private LeakyBucket getBucket(String key) { + LeakyBucket bucket = (LeakyBucket)memcachedClient.get(getBucketName(key)); + + if (bucket == null) { + return new LeakyBucket(bucketSize, leakRatePerMillis); + } else { + return bucket; + } + } + + private String getBucketName(String key) { + return LeakyBucket.class.getSimpleName() + name + key; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiters.java b/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiters.java new file mode 100644 index 000000000..d17c652f3 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/limits/RateLimiters.java @@ -0,0 +1,92 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.limits; + + +import net.spy.memcached.MemcachedClient; +import org.whispersystems.textsecuregcm.configuration.RateLimitsConfiguration; + +public class RateLimiters { + + private final RateLimiter smsDestinationLimiter; + private final RateLimiter voiceDestinationLimiter; + private final RateLimiter verifyLimiter; + + private final RateLimiter attachmentLimiter; + private final RateLimiter contactsLimiter; + private final RateLimiter preKeysLimiter; + private final RateLimiter messagesLimiter; + + public RateLimiters(RateLimitsConfiguration config, MemcachedClient memcachedClient) { + this.smsDestinationLimiter = new RateLimiter(memcachedClient, "smsDestination", + config.getSmsDestination().getBucketSize(), + config.getSmsDestination().getLeakRatePerMinute()); + + this.voiceDestinationLimiter = new RateLimiter(memcachedClient, "voxDestination", + config.getVoiceDestination().getBucketSize(), + config.getVoiceDestination().getLeakRatePerMinute()); + + this.verifyLimiter = new RateLimiter(memcachedClient, "verify", + config.getVerifyNumber().getBucketSize(), + config.getVerifyNumber().getLeakRatePerMinute()); + + this.attachmentLimiter = new RateLimiter(memcachedClient, "attachmentCreate", + config.getAttachments().getBucketSize(), + config.getAttachments().getLeakRatePerMinute()); + + this.contactsLimiter = new RateLimiter(memcachedClient, "contactsQuery", + config.getContactQueries().getBucketSize(), + config.getContactQueries().getLeakRatePerMinute()); + + this.preKeysLimiter = new RateLimiter(memcachedClient, "prekeys", + config.getPreKeys().getBucketSize(), + config.getPreKeys().getLeakRatePerMinute()); + + this.messagesLimiter = new RateLimiter(memcachedClient, "messages", + config.getMessages().getBucketSize(), + config.getMessages().getLeakRatePerMinute()); + } + + public RateLimiter getMessagesLimiter() { + return messagesLimiter; + } + + public RateLimiter getPreKeysLimiter() { + return preKeysLimiter; + } + + public RateLimiter getContactsLimiter() { + return contactsLimiter; + } + + public RateLimiter getAttachmentLimiter() { + return this.attachmentLimiter; + } + + public RateLimiter getSmsDestinationLimiter() { + return smsDestinationLimiter; + } + + public RateLimiter getVoiceDestinationLimiter() { + return voiceDestinationLimiter; + } + + public RateLimiter getVerifyLimiter() { + return verifyLimiter; + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/mappers/IOExceptionMapper.java b/src/main/java/org/whispersystems/textsecuregcm/mappers/IOExceptionMapper.java new file mode 100644 index 000000000..9aafeff9c --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/mappers/IOExceptionMapper.java @@ -0,0 +1,37 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.mappers; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; +import java.io.IOException; + +@Provider +public class IOExceptionMapper implements ExceptionMapper { + + private final Logger logger = LoggerFactory.getLogger(IOExceptionMapper.class); + + @Override + public Response toResponse(IOException e) { + logger.warn("IOExceptionMapper", e); + return Response.status(503).build(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/mappers/RateLimitExceededExceptionMapper.java b/src/main/java/org/whispersystems/textsecuregcm/mappers/RateLimitExceededExceptionMapper.java new file mode 100644 index 000000000..a2609cb90 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/mappers/RateLimitExceededExceptionMapper.java @@ -0,0 +1,31 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.mappers; + +import org.whispersystems.textsecuregcm.controllers.RateLimitExceededException; + +import javax.ws.rs.core.Response; +import javax.ws.rs.ext.ExceptionMapper; +import javax.ws.rs.ext.Provider; + +@Provider +public class RateLimitExceededExceptionMapper implements ExceptionMapper { + @Override + public Response toResponse(RateLimitExceededException e) { + return Response.status(413).build(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/providers/MemcacheHealthCheck.java b/src/main/java/org/whispersystems/textsecuregcm/providers/MemcacheHealthCheck.java new file mode 100644 index 000000000..41c407273 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/providers/MemcacheHealthCheck.java @@ -0,0 +1,53 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.providers; + +import com.yammer.metrics.core.HealthCheck; +import com.yammer.metrics.core.HealthCheck.Result; +import net.spy.memcached.MemcachedClient; + +import java.security.SecureRandom; + +public class MemcacheHealthCheck extends HealthCheck { + + private final MemcachedClient client; + + public MemcacheHealthCheck(MemcachedClient client) { + super("memcached"); + this.client = client; + } + + @Override + protected Result check() throws Exception { + if (client == null) { + return Result.unhealthy("not configured"); + } + + int random = SecureRandom.getInstance("SHA1PRNG").nextInt(); + int value = SecureRandom.getInstance("SHA1PRNG").nextInt(); + + this.client.set("HEALTH" + random, 2000, String.valueOf(value)); + String result = (String)this.client.get("HEALTH" + random); + + if (result == null || Integer.parseInt(result) != value) { + return Result.unhealthy("Fetch failed"); + } + + return Result.healthy(); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/providers/MemcachedClientFactory.java b/src/main/java/org/whispersystems/textsecuregcm/providers/MemcachedClientFactory.java new file mode 100644 index 000000000..e73873780 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/providers/MemcachedClientFactory.java @@ -0,0 +1,54 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.providers; + +import net.spy.memcached.AddrUtil; +import net.spy.memcached.ConnectionFactoryBuilder; +import net.spy.memcached.MemcachedClient; +import net.spy.memcached.auth.AuthDescriptor; +import net.spy.memcached.auth.PlainCallbackHandler; +import org.whispersystems.textsecuregcm.configuration.MemcacheConfiguration; +import org.whispersystems.textsecuregcm.util.Util; + +import java.io.IOException; + +public class MemcachedClientFactory { + + private final MemcachedClient client; + + public MemcachedClientFactory(MemcacheConfiguration config) throws IOException { + ConnectionFactoryBuilder builder = new ConnectionFactoryBuilder(); + builder.setProtocol(ConnectionFactoryBuilder.Protocol.BINARY); + + if (!Util.isEmpty(config.getUser())) { + AuthDescriptor ad = new AuthDescriptor(new String[] { "PLAIN" }, + new PlainCallbackHandler(config.getUser(), + config.getPassword())); + + builder.setAuthDescriptor(ad); + } + + + this.client = new MemcachedClient(builder.build(), + AddrUtil.getAddresses(config.getServers())); + } + + + public MemcachedClient getClient() { + return client; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/providers/RedisClientFactory.java b/src/main/java/org/whispersystems/textsecuregcm/providers/RedisClientFactory.java new file mode 100644 index 000000000..111f2f80c --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/providers/RedisClientFactory.java @@ -0,0 +1,54 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.providers; + +import org.whispersystems.textsecuregcm.configuration.RedisConfiguration; +import org.whispersystems.textsecuregcm.util.Util; + +import java.net.URI; +import java.net.URISyntaxException; + +import redis.clients.jedis.JedisPool; +import redis.clients.jedis.JedisPoolConfig; +import redis.clients.jedis.Protocol; + +public class RedisClientFactory { + + private final JedisPool jedisPool; + + public RedisClientFactory(RedisConfiguration redisConfig) throws URISyntaxException { + JedisPoolConfig poolConfig = new JedisPoolConfig(); + poolConfig.setTestOnBorrow(true); + + URI redisURI = new URI(redisConfig.getUrl()); + String redisHost = redisURI.getHost(); + int redisPort = redisURI.getPort(); + String redisPassword = null; + + if (!Util.isEmpty(redisURI.getUserInfo())) { + redisPassword = redisURI.getUserInfo().split(":",2)[1]; + } + + this.jedisPool = new JedisPool(poolConfig, redisHost, redisPort, + Protocol.DEFAULT_TIMEOUT, redisPassword); + } + + public JedisPool getRedisClientPool() { + return jedisPool; + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/providers/RedisHealthCheck.java b/src/main/java/org/whispersystems/textsecuregcm/providers/RedisHealthCheck.java new file mode 100644 index 000000000..c0a661eac --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/providers/RedisHealthCheck.java @@ -0,0 +1,49 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.providers; + +import com.yammer.metrics.core.HealthCheck; + +import redis.clients.jedis.Jedis; +import redis.clients.jedis.JedisPool; + +public class RedisHealthCheck extends HealthCheck { + + private final JedisPool clientPool; + + public RedisHealthCheck(JedisPool clientPool) { + super("redis"); + this.clientPool = clientPool; + } + + @Override + protected Result check() throws Exception { + Jedis client = clientPool.getResource(); + + try { + client.set("HEALTH", "test"); + + if (!"test".equals(client.get("HEALTH"))) { + return Result.unhealthy("fetch failed"); + } + + return Result.healthy(); + } finally { + clientPool.returnResource(client); + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/push/APNSender.java b/src/main/java/org/whispersystems/textsecuregcm/push/APNSender.java new file mode 100644 index 000000000..5591ab175 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/push/APNSender.java @@ -0,0 +1,116 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.push; + +import com.google.common.base.Optional; +import com.notnoop.apns.APNS; +import com.notnoop.apns.ApnsService; +import com.notnoop.exceptions.NetworkIOException; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.bouncycastle.openssl.PEMReader; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.EncryptedOutgoingMessage; +import org.whispersystems.textsecuregcm.util.Util; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.MalformedURLException; +import java.security.KeyPair; +import java.security.KeyStore; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.cert.Certificate; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; +import java.util.concurrent.TimeUnit; + +public class APNSender { + + private final Meter success = Metrics.newMeter(APNSender.class, "sent", "success", TimeUnit.MINUTES); + private final Meter failure = Metrics.newMeter(APNSender.class, "sent", "failure", TimeUnit.MINUTES); + private final Logger logger = LoggerFactory.getLogger(APNSender.class); + + private static final String MESSAGE_BODY = "m"; + + private final Optional apnService; + + public APNSender(String apnCertificate, String apnKey) + throws CertificateException, NoSuchAlgorithmException, KeyStoreException, IOException + { + if (!Util.isEmpty(apnCertificate) && !Util.isEmpty(apnKey)) { + byte[] keyStore = initializeKeyStore(apnCertificate, apnKey); + this.apnService = Optional.of(APNS.newService() + .withCert(new ByteArrayInputStream(keyStore), "insecure") + .withSandboxDestination().build()); + } else { + this.apnService = Optional.absent(); + } + } + + public void sendMessage(String registrationId, EncryptedOutgoingMessage message) + throws IOException + { + try { + if (!apnService.isPresent()) { + failure.mark(); + throw new IOException("APN access not configured!"); + } + + String payload = APNS.newPayload() + .alertBody("Message!") + .customField(MESSAGE_BODY, message.serialize()) + .build(); + + logger.debug("APN Payload: " + payload); + + apnService.get().push(registrationId, payload); + success.mark(); + } catch (MalformedURLException mue) { + throw new AssertionError(mue); + } catch (NetworkIOException nioe) { + logger.warn("Network Error", nioe); + failure.mark(); + throw new IOException("Error sending APN"); + } + } + + private static byte[] initializeKeyStore(String pemCertificate, String pemKey) + throws KeyStoreException, CertificateException, NoSuchAlgorithmException, IOException + { + PEMReader reader = new PEMReader(new InputStreamReader(new ByteArrayInputStream(pemCertificate.getBytes()))); + X509Certificate certificate = (X509Certificate) reader.readObject(); + Certificate[] certificateChain = {certificate}; + + reader = new PEMReader(new InputStreamReader(new ByteArrayInputStream(pemKey.getBytes()))); + KeyPair keyPair = (KeyPair) reader.readObject(); + + KeyStore keyStore = KeyStore.getInstance("pkcs12"); + keyStore.load(null); + keyStore.setEntry("apn", + new KeyStore.PrivateKeyEntry(keyPair.getPrivate(), certificateChain), + new KeyStore.PasswordProtection("insecure".toCharArray())); + + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + keyStore.store(baos, "insecure".toCharArray()); + + return baos.toByteArray(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/push/GCMSender.java b/src/main/java/org/whispersystems/textsecuregcm/push/GCMSender.java new file mode 100644 index 000000000..350bd7d02 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/push/GCMSender.java @@ -0,0 +1,63 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.push; + +import com.google.android.gcm.server.Constants; +import com.google.android.gcm.server.Message; +import com.google.android.gcm.server.Result; +import com.google.android.gcm.server.Sender; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.whispersystems.textsecuregcm.controllers.NoSuchUserException; +import org.whispersystems.textsecuregcm.entities.EncryptedOutgoingMessage; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +public class GCMSender { + + private final Meter success = Metrics.newMeter(GCMSender.class, "sent", "success", TimeUnit.MINUTES); + private final Meter failure = Metrics.newMeter(GCMSender.class, "sent", "failure", TimeUnit.MINUTES); + + private final Sender sender; + + public GCMSender(String apiKey) { + this.sender = new Sender(apiKey); + } + + public String sendMessage(String gcmRegistrationId, EncryptedOutgoingMessage outgoingMessage) + throws IOException, NoSuchUserException + { + Message gcmMessage = new Message.Builder().addData("type", "message") + .addData("message", outgoingMessage.serialize()) + .build(); + + Result result = sender.send(gcmMessage, gcmRegistrationId, 5); + + if (result.getMessageId() != null) { + success.mark(); + return result.getCanonicalRegistrationId(); + } else { + failure.mark(); + if (result.getErrorCodeName().equals(Constants.ERROR_NOT_REGISTERED)) { + throw new NoSuchUserException("User no longer registered with GCM."); + } else { + throw new IOException("GCM Failed: " + result.getErrorCodeName()); + } + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/push/PushSender.java b/src/main/java/org/whispersystems/textsecuregcm/push/PushSender.java new file mode 100644 index 000000000..a440f6c0d --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/push/PushSender.java @@ -0,0 +1,103 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.push; + +import com.google.common.base.Optional; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.configuration.ApnConfiguration; +import org.whispersystems.textsecuregcm.configuration.GcmConfiguration; +import org.whispersystems.textsecuregcm.controllers.NoSuchUserException; +import org.whispersystems.textsecuregcm.entities.EncryptedOutgoingMessage; +import org.whispersystems.textsecuregcm.entities.MessageProtos; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.DirectoryManager; + +import java.io.IOException; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.cert.CertificateException; + +public class PushSender { + + private final Logger logger = LoggerFactory.getLogger(PushSender.class); + + private final AccountsManager accounts; + private final DirectoryManager directory; + + private final GCMSender gcmSender; + private final APNSender apnSender; + + public PushSender(GcmConfiguration gcmConfiguration, + ApnConfiguration apnConfiguration, + AccountsManager accounts, + DirectoryManager directory) + throws CertificateException, NoSuchAlgorithmException, KeyStoreException, IOException + { + this.accounts = accounts; + this.directory = directory; + + this.gcmSender = new GCMSender(gcmConfiguration.getApiKey()); + this.apnSender = new APNSender(apnConfiguration.getCertificate(), apnConfiguration.getKey()); + } + + public void sendMessage(String destination, MessageProtos.OutgoingMessageSignal outgoingMessage) + throws IOException, NoSuchUserException + { + Optional account = accounts.get(destination); + + if (!account.isPresent()) { + directory.remove(destination); + throw new NoSuchUserException("No such local destination: " + destination); + } + + String signalingKey = account.get().getSignalingKey(); + EncryptedOutgoingMessage message = new EncryptedOutgoingMessage(outgoingMessage, signalingKey); + + if (account.get().getGcmRegistrationId() != null) sendGcmMessage(account.get(), message); + else if (account.get().getApnRegistrationId() != null) sendApnMessage(account.get(), message); + else throw new NoSuchUserException("No push identifier!"); + } + + private void sendGcmMessage(Account account, EncryptedOutgoingMessage outgoingMessage) + throws IOException, NoSuchUserException + { + try { + String canonicalId = gcmSender.sendMessage(account.getGcmRegistrationId(), + outgoingMessage); + + if (canonicalId != null) { + account.setGcmRegistrationId(canonicalId); + accounts.update(account); + } + + } catch (NoSuchUserException e) { + logger.debug("No Such User", e); + account.setGcmRegistrationId(null); + accounts.update(account); + throw new NoSuchUserException("User no longer exists in GCM."); + } + } + + private void sendApnMessage(Account account, EncryptedOutgoingMessage outgoingMessage) + throws IOException + { + apnSender.sendMessage(account.getApnRegistrationId(), outgoingMessage); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/sms/NexmoSmsSender.java b/src/main/java/org/whispersystems/textsecuregcm/sms/NexmoSmsSender.java new file mode 100644 index 000000000..78f1eb50f --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/sms/NexmoSmsSender.java @@ -0,0 +1,92 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.sms; + +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.configuration.NexmoConfiguration; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URL; +import java.net.URLConnection; +import java.net.URLEncoder; +import java.util.concurrent.TimeUnit; + +import org.whispersystems.textsecuregcm.sms.SenderFactory.VoxSender; +import org.whispersystems.textsecuregcm.sms.SenderFactory.SmsSender; + +public class NexmoSmsSender implements SmsSender, VoxSender { + + private final Meter smsMeter = Metrics.newMeter(NexmoSmsSender.class, "sms", "delivered", TimeUnit.MINUTES); + private final Meter voxMeter = Metrics.newMeter(NexmoSmsSender.class, "vox", "delivered", TimeUnit.MINUTES); + private final Logger logger = LoggerFactory.getLogger(NexmoSmsSender.class); + + private static final String NEXMO_SMS_URL = + "https://rest.nexmo.com/sms/json?api_key=%s&api_secret=%s&from=%s&to=%s&text=%s"; + + private static final String NEXMO_VOX_URL = + "https://rest.nexmo.com/tts/json?api_key=%s&api_secret=%s&to=%s&text=%s"; + + private final String apiKey; + private final String apiSecret; + private final String number; + + public NexmoSmsSender(NexmoConfiguration config) { + this.apiKey = config.getApiKey(); + this.apiSecret = config.getApiSecret(); + this.number = config.getNumber(); + } + + @Override + public void deliverSmsVerification(String destination, String verificationCode) throws IOException { + URL url = new URL(String.format(NEXMO_SMS_URL, apiKey, apiSecret, number, destination, + URLEncoder.encode(SmsSender.VERIFICATION_TEXT + verificationCode, "UTF-8"))); + + URLConnection connection = url.openConnection(); + connection.setDoInput(true); + connection.connect(); + + BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream())); + while (reader.readLine() != null) {} + reader.close(); + smsMeter.mark(); + } + + @Override + public void deliverVoxVerification(String destination, String message) throws IOException { + URL url = new URL(String.format(NEXMO_VOX_URL, apiKey, apiSecret, destination, + URLEncoder.encode(VoxSender.VERIFICATION_TEXT + message, "UTF-8"))); + + URLConnection connection = url.openConnection(); + connection.setDoInput(true); + connection.connect(); + + BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream())); + String line; + while ((line = reader.readLine()) != null) { + logger.debug(line); + } + reader.close(); + voxMeter.mark(); + } + + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/sms/SenderFactory.java b/src/main/java/org/whispersystems/textsecuregcm/sms/SenderFactory.java new file mode 100644 index 000000000..e74796602 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/sms/SenderFactory.java @@ -0,0 +1,70 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.sms; + + +import com.google.common.base.Optional; +import org.whispersystems.textsecuregcm.configuration.NexmoConfiguration; +import org.whispersystems.textsecuregcm.configuration.TwilioConfiguration; + +import java.io.IOException; + +public class SenderFactory { + + private final TwilioSmsSender twilioSender; + private final Optional nexmoSender; + + public SenderFactory(TwilioConfiguration twilioConfig, NexmoConfiguration nexmoConfig) { + this.twilioSender = new TwilioSmsSender(twilioConfig); + + if (nexmoConfig != null) { + this.nexmoSender = Optional.of(new NexmoSmsSender(nexmoConfig)); + } else { + this.nexmoSender = Optional.absent(); + } + } + + public SmsSender getSmsSender(String number) { + if (nexmoSender.isPresent() && !isTwilioDestination(number)) { + return nexmoSender.get(); + } else { + return twilioSender; + } + } + + public VoxSender getVoxSender(String number) { + if (nexmoSender.isPresent()) { + return nexmoSender.get(); + } + + throw new AssertionError("FIX ME!"); + } + + private boolean isTwilioDestination(String number) { + return number.length() == 12 && number.startsWith("+1"); + } + + public interface SmsSender { + public static final String VERIFICATION_TEXT = "Your TextSecure verification code: "; + public void deliverSmsVerification(String destination, String verificationCode) throws IOException; + } + + public interface VoxSender { + public static final String VERIFICATION_TEXT = "Your TextSecure verification code is: "; + public void deliverVoxVerification(String destination, String verificationCode) throws IOException; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/sms/TwilioSmsSender.java b/src/main/java/org/whispersystems/textsecuregcm/sms/TwilioSmsSender.java new file mode 100644 index 000000000..46fecbd79 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/sms/TwilioSmsSender.java @@ -0,0 +1,81 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.sms; + +import com.sun.jersey.core.util.Base64; +import com.yammer.metrics.Metrics; +import com.yammer.metrics.core.Meter; +import org.whispersystems.textsecuregcm.configuration.TwilioConfiguration; +import org.whispersystems.textsecuregcm.util.Util; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.OutputStreamWriter; +import java.net.URL; +import java.net.URLConnection; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.TimeUnit; + +public class TwilioSmsSender implements SenderFactory.SmsSender { + + private final Meter smsMeter = Metrics.newMeter(TwilioSmsSender.class, "sms", "delivered", TimeUnit.MINUTES); + + private static final String TWILIO_URL = "https://api.twilio.com/2010-04-01/Accounts/%s/SMS/Messages"; + + private final String accountId; + private final String accountToken; + private final String number; + + public TwilioSmsSender(TwilioConfiguration config) { + this.accountId = config.getAccountId(); + this.accountToken = config.getAccountToken(); + this.number = config.getNumber(); + } + + @Override + public void deliverSmsVerification(String destination, String verificationCode) throws IOException { + URL url = new URL(String.format(TWILIO_URL, accountId)); + URLConnection connection = url.openConnection(); + connection.setDoOutput(true); + connection.setRequestProperty("Authorization", getTwilioAuthorizationHeader()); + connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); + + Map formData = new HashMap<>(); + formData.put("From", number); + formData.put("To", destination); + formData.put("Body", VERIFICATION_TEXT + verificationCode); + + OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream()); + writer.write(Util.encodeFormParams(formData)); + writer.flush(); + + BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream())); + while (reader.readLine() != null) {} + writer.close(); + reader.close(); + + smsMeter.mark(); + } + + private String getTwilioAuthorizationHeader() { + String encoded = new String(Base64.encode(String.format("%s:%s", accountId, accountToken))); + return "Basic " + encoded.replace("\n", ""); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/Account.java b/src/main/java/org/whispersystems/textsecuregcm/storage/Account.java new file mode 100644 index 000000000..41ff1c428 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/Account.java @@ -0,0 +1,109 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + + +import org.whispersystems.textsecuregcm.auth.AuthenticationCredentials; + +import java.io.Serializable; + +public class Account implements Serializable { + + public static final int MEMCACHE_VERION = 1; + + private long id; + private String number; + private String hashedAuthenticationToken; + private String salt; + private String signalingKey; + private String gcmRegistrationId; + private String apnRegistrationId; + private boolean supportsSms; + + public Account() {} + + public Account(long id, String number, String hashedAuthenticationToken, String salt, + String signalingKey, String gcmRegistrationId, String apnRegistrationId, + boolean supportsSms) + { + this.id = id; + this.number = number; + this.hashedAuthenticationToken = hashedAuthenticationToken; + this.salt = salt; + this.signalingKey = signalingKey; + this.gcmRegistrationId = gcmRegistrationId; + this.apnRegistrationId = apnRegistrationId; + this.supportsSms = supportsSms; + } + + public String getApnRegistrationId() { + return apnRegistrationId; + } + + public void setApnRegistrationId(String apnRegistrationId) { + this.apnRegistrationId = apnRegistrationId; + } + + public String getGcmRegistrationId() { + return gcmRegistrationId; + } + + public void setGcmRegistrationId(String gcmRegistrationId) { + this.gcmRegistrationId = gcmRegistrationId; + } + + public void setNumber(String number) { + this.number = number; + } + + public String getNumber() { + return number; + } + + public void setAuthenticationCredentials(AuthenticationCredentials credentials) { + this.hashedAuthenticationToken = credentials.getHashedAuthenticationToken(); + this.salt = credentials.getSalt(); + } + + public AuthenticationCredentials getAuthenticationCredentials() { + return new AuthenticationCredentials(hashedAuthenticationToken, salt); + } + + public String getSignalingKey() { + return signalingKey; + } + + public void setSignalingKey(String signalingKey) { + this.signalingKey = signalingKey; + } + + public boolean getSupportsSms() { + return supportsSms; + } + + public void setSupportsSms(boolean supportsSms) { + this.supportsSms = supportsSms; + } + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/Accounts.java b/src/main/java/org/whispersystems/textsecuregcm/storage/Accounts.java new file mode 100644 index 000000000..ba941846f --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/Accounts.java @@ -0,0 +1,133 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + +import org.skife.jdbi.v2.SQLStatement; +import org.skife.jdbi.v2.StatementContext; +import org.skife.jdbi.v2.TransactionIsolationLevel; +import org.skife.jdbi.v2.sqlobject.Bind; +import org.skife.jdbi.v2.sqlobject.Binder; +import org.skife.jdbi.v2.sqlobject.BinderFactory; +import org.skife.jdbi.v2.sqlobject.BindingAnnotation; +import org.skife.jdbi.v2.sqlobject.GetGeneratedKeys; +import org.skife.jdbi.v2.sqlobject.SqlQuery; +import org.skife.jdbi.v2.sqlobject.SqlUpdate; +import org.skife.jdbi.v2.sqlobject.Transaction; +import org.skife.jdbi.v2.sqlobject.customizers.Mapper; +import org.skife.jdbi.v2.tweak.ResultSetMapper; + +import java.lang.annotation.Annotation; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Iterator; +import java.util.List; + +public abstract class Accounts { + + public static final String ID = "id"; + public static final String NUMBER = "number"; + public static final String AUTH_TOKEN = "auth_token"; + public static final String SALT = "salt"; + public static final String SIGNALING_KEY = "signaling_key"; + public static final String GCM_ID = "gcm_id"; + public static final String APN_ID = "apn_id"; + public static final String SUPPORTS_SMS = "supports_sms"; + + @SqlUpdate("INSERT INTO accounts (" + NUMBER + ", " + AUTH_TOKEN + ", " + + SALT + ", " + SIGNALING_KEY + ", " + GCM_ID + ", " + + APN_ID + ", " + SUPPORTS_SMS + ") " + + "VALUES (:number, :auth_token, :salt, :signaling_key, :gcm_id, :apn_id, :supports_sms)") + @GetGeneratedKeys + abstract long createStep(@AccountBinder Account account); + + @SqlUpdate("DELETE FROM accounts WHERE number = :number") + abstract void removeStep(@Bind("number") String number); + + @SqlUpdate("UPDATE accounts SET " + AUTH_TOKEN + " = :auth_token, " + SALT + " = :salt, " + + SIGNALING_KEY + " = :signaling_key, " + GCM_ID + " = :gcm_id, " + + APN_ID + " = :apn_id, " + SUPPORTS_SMS + " = :supports_sms " + + "WHERE " + NUMBER + " = :number") + abstract void update(@AccountBinder Account account); + + @Mapper(AccountMapper.class) + @SqlQuery("SELECT * FROM accounts WHERE " + NUMBER + " = :number") + abstract Account get(@Bind("number") String number); + + @SqlQuery("SELECT COUNT(*) from accounts") + abstract long getCount(); + + @Mapper(AccountMapper.class) + @SqlQuery("SELECT * FROM accounts OFFSET :offset LIMIT :limit") + abstract List getAll(@Bind("offset") int offset, @Bind("limit") int length); + + @Mapper(AccountMapper.class) + @SqlQuery("SELECT * FROM accounts") + abstract Iterator getAll(); + + @Transaction(TransactionIsolationLevel.REPEATABLE_READ) + public long create(Account account) { + removeStep(account.getNumber()); + return createStep(account); + } + + public static class AccountMapper implements ResultSetMapper { + + @Override + public Account map(int i, ResultSet resultSet, StatementContext statementContext) + throws SQLException + { + return new Account(resultSet.getLong(ID), resultSet.getString(NUMBER), + resultSet.getString(AUTH_TOKEN), resultSet.getString(SALT), + resultSet.getString(SIGNALING_KEY), resultSet.getString(GCM_ID), + resultSet.getString(APN_ID), + resultSet.getInt(SUPPORTS_SMS) == 1); + } + } + + @BindingAnnotation(AccountBinder.AccountBinderFactory.class) + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.PARAMETER}) + public @interface AccountBinder { + public static class AccountBinderFactory implements BinderFactory { + @Override + public Binder build(Annotation annotation) { + return new Binder() { + @Override + public void bind(SQLStatement sql, + AccountBinder accountBinder, + Account account) + { + sql.bind(ID, account.getId()); + sql.bind(NUMBER, account.getNumber()); + sql.bind(AUTH_TOKEN, account.getAuthenticationCredentials() + .getHashedAuthenticationToken()); + sql.bind(SALT, account.getAuthenticationCredentials().getSalt()); + sql.bind(SIGNALING_KEY, account.getSignalingKey()); + sql.bind(GCM_ID, account.getGcmRegistrationId()); + sql.bind(APN_ID, account.getApnRegistrationId()); + sql.bind(SUPPORTS_SMS, account.getSupportsSms() ? 1 : 0); + } + }; + } + } + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/AccountsManager.java b/src/main/java/org/whispersystems/textsecuregcm/storage/AccountsManager.java new file mode 100644 index 000000000..adfc87285 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/AccountsManager.java @@ -0,0 +1,108 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + + +import com.google.common.base.Optional; +import net.spy.memcached.MemcachedClient; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.util.Util; + +import java.util.Iterator; +import java.util.List; + +public class AccountsManager { + + private final Accounts accounts; + private final MemcachedClient memcachedClient; + private final DirectoryManager directory; + + public AccountsManager(Accounts accounts, + DirectoryManager directory, + MemcachedClient memcachedClient) + { + this.accounts = accounts; + this.directory = directory; + this.memcachedClient = memcachedClient; + } + + public long getCount() { + return accounts.getCount(); + } + + public List getAll(int offset, int length) { + return accounts.getAll(offset, length); + } + + public Iterator getAll() { + return accounts.getAll(); + } + + public void create(Account account) { + long id = accounts.create(account); + + account.setId(id); + + if (memcachedClient != null) { + memcachedClient.set(getKey(account.getNumber()), 0, account); + } + + updateDirectory(account); + } + + public void update(Account account) { + if (memcachedClient != null) { + memcachedClient.set(getKey(account.getNumber()), 0, account); + } + + accounts.update(account); + updateDirectory(account); + } + + public Optional get(String number) { + Account account = null; + + if (memcachedClient != null) { + account = (Account)memcachedClient.get(getKey(number)); + } + + if (account == null) { + account = accounts.get(number); + + if (account != null && memcachedClient != null) { + memcachedClient.set(getKey(number), 0, account); + } + } + + if (account != null) return Optional.of(account); + else return Optional.absent(); + } + + private void updateDirectory(Account account) { + if (account.getGcmRegistrationId() != null || account.getApnRegistrationId() != null) { + byte[] token = Util.getContactToken(account.getNumber()); + ClientContact clientContact = new ClientContact(token, null, account.getSupportsSms()); + directory.add(clientContact); + } else { + directory.remove(account.getNumber()); + } + } + + private String getKey(String number) { + return Account.class.getSimpleName() + Account.MEMCACHE_VERION + number; + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/DirectoryManager.java b/src/main/java/org/whispersystems/textsecuregcm/storage/DirectoryManager.java new file mode 100644 index 000000000..269af4628 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/DirectoryManager.java @@ -0,0 +1,164 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + +import com.google.common.base.Optional; +import com.google.gson.Gson; +import com.google.gson.annotations.SerializedName; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.util.IterablePair; +import org.whispersystems.textsecuregcm.util.Util; + +import java.util.LinkedList; +import java.util.List; + +import redis.clients.jedis.Jedis; +import redis.clients.jedis.JedisPool; +import redis.clients.jedis.Pipeline; +import redis.clients.jedis.Response; + +public class DirectoryManager { + + private static final byte[] DIRECTORY_KEY = {'d', 'i', 'r', 'e', 'c', 't', 'o', 'r', 'y'}; + + private final JedisPool redisPool; + + public DirectoryManager(JedisPool redisPool) { + this.redisPool = redisPool; + } + + public void remove(String number) { + remove(Util.getContactToken(number)); + } + + public void remove(BatchOperationHandle handle, String number) { + remove(handle, Util.getContactToken(number)); + } + + public void remove(byte[] token) { + Jedis jedis = redisPool.getResource(); + jedis.hdel(DIRECTORY_KEY, token); + redisPool.returnResource(jedis); + } + + public void remove(BatchOperationHandle handle, byte[] token) { + Pipeline pipeline = handle.pipeline; + pipeline.hdel(DIRECTORY_KEY, token); + } + + public void add(ClientContact contact) { + TokenValue tokenValue = new TokenValue(contact.getRelay(), contact.isSupportsSms()); + Jedis jedis = redisPool.getResource(); + + jedis.hset(DIRECTORY_KEY, contact.getToken(), new Gson().toJson(tokenValue).getBytes()); + redisPool.returnResource(jedis); + } + + public void add(BatchOperationHandle handle, ClientContact contact) { + Pipeline pipeline = handle.pipeline; + TokenValue tokenValue = new TokenValue(contact.getRelay(), contact.isSupportsSms()); + + pipeline.hset(DIRECTORY_KEY, contact.getToken(), new Gson().toJson(tokenValue).getBytes()); + } + + public Optional get(byte[] token) { + Jedis jedis = redisPool.getResource(); + + try { + byte[] result = jedis.hget(DIRECTORY_KEY, token); + + if (result == null) { + return Optional.absent(); + } + + TokenValue tokenValue = new Gson().fromJson(new String(result), TokenValue.class); + return Optional.of(new ClientContact(token, tokenValue.relay, tokenValue.supportsSms)); + } finally { + redisPool.returnResource(jedis); + } + } + + public List get(List tokens) { + Jedis jedis = redisPool.getResource(); + + try { + Pipeline pipeline = jedis.pipelined(); + List> futures = new LinkedList<>(); + List results = new LinkedList<>(); + + try { + for (byte[] token : tokens) { + futures.add(pipeline.hget(DIRECTORY_KEY, token)); + } + } finally { + pipeline.sync(); + } + + IterablePair> lists = new IterablePair<>(tokens, futures); + + for (IterablePair.Pair> pair : lists) { + if (pair.second().get() != null) { + TokenValue tokenValue = new Gson().fromJson(new String(pair.second().get()), TokenValue.class); + ClientContact clientContact = new ClientContact(pair.first(), tokenValue.relay, tokenValue.supportsSms); + + results.add(clientContact); + } + } + + return results; + } finally { + redisPool.returnResource(jedis); + } + } + + public BatchOperationHandle startBatchOperation() { + Jedis jedis = redisPool.getResource(); + return new BatchOperationHandle(jedis, jedis.pipelined()); + } + + public void stopBatchOperation(BatchOperationHandle handle) { + Pipeline pipeline = handle.pipeline; + Jedis jedis = handle.jedis; + + pipeline.sync(); + redisPool.returnResource(jedis); + } + + public static class BatchOperationHandle { + + public final Pipeline pipeline; + public final Jedis jedis; + + public BatchOperationHandle(Jedis jedis, Pipeline pipeline) { + this.pipeline = pipeline; + this.jedis = jedis; + } + } + + private static class TokenValue { + @SerializedName("r") + private String relay; + + @SerializedName("s") + private boolean supportsSms; + + public TokenValue(String relay, boolean supportsSms) { + this.relay = relay; + this.supportsSms = supportsSms; + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/Keys.java b/src/main/java/org/whispersystems/textsecuregcm/storage/Keys.java new file mode 100644 index 000000000..16cf88d2b --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/Keys.java @@ -0,0 +1,121 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + +import org.skife.jdbi.v2.SQLStatement; +import org.skife.jdbi.v2.StatementContext; +import org.skife.jdbi.v2.TransactionIsolationLevel; +import org.skife.jdbi.v2.sqlobject.Bind; +import org.skife.jdbi.v2.sqlobject.Binder; +import org.skife.jdbi.v2.sqlobject.BinderFactory; +import org.skife.jdbi.v2.sqlobject.BindingAnnotation; +import org.skife.jdbi.v2.sqlobject.SqlBatch; +import org.skife.jdbi.v2.sqlobject.SqlQuery; +import org.skife.jdbi.v2.sqlobject.SqlUpdate; +import org.skife.jdbi.v2.sqlobject.Transaction; +import org.skife.jdbi.v2.sqlobject.customizers.Mapper; +import org.skife.jdbi.v2.tweak.ResultSetMapper; +import org.whispersystems.textsecuregcm.entities.PreKey; + +import java.lang.annotation.Annotation; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.List; + +public abstract class Keys { + + @SqlUpdate("DELETE FROM keys WHERE number = :number") + abstract void removeKeys(@Bind("number") String number); + + @SqlUpdate("DELETE FROM keys WHERE id = :id") + abstract void removeKey(@Bind("id") long id); + + @SqlBatch("INSERT INTO keys (number, key_id, public_key, identity_key, last_resort) VALUES (:number, :key_id, :public_key, :identity_key, :last_resort)") + abstract void append(@PreKeyBinder List preKeys); + + @SqlUpdate("INSERT INTO keys (number, key_id, public_key, identity_key, last_resort) VALUES (:number, :key_id, :public_key, :identity_key, :last_resort)") + abstract void append(@PreKeyBinder PreKey preKey); + + @SqlQuery("SELECT * FROM keys WHERE number = :number ORDER BY id LIMIT 1 FOR UPDATE") + @Mapper(PreKeyMapper.class) + abstract PreKey retrieveFirst(@Bind("number") String number); + + @Transaction(TransactionIsolationLevel.SERIALIZABLE) + public void store(String number, PreKey lastResortKey, List keys) { + for (PreKey key : keys) { + key.setNumber(number); + } + + lastResortKey.setNumber(number); + + removeKeys(number); + append(keys); + append(lastResortKey); + } + + @Transaction(TransactionIsolationLevel.SERIALIZABLE) + public PreKey get(String number) { + PreKey preKey = retrieveFirst(number); + + if (preKey != null && !preKey.isLastResort()) { + removeKey(preKey.getId()); + } + + return preKey; + } + + @BindingAnnotation(PreKeyBinder.PreKeyBinderFactory.class) + @Retention(RetentionPolicy.RUNTIME) + @Target({ElementType.PARAMETER}) + public @interface PreKeyBinder { + public static class PreKeyBinderFactory implements BinderFactory { + @Override + public Binder build(Annotation annotation) { + return new Binder() { + @Override + public void bind(SQLStatement sql, PreKeyBinder accountBinder, PreKey preKey) + { + sql.bind("id", preKey.getId()); + sql.bind("number", preKey.getNumber()); + sql.bind("key_id", preKey.getKeyId()); + sql.bind("public_key", preKey.getPublicKey()); + sql.bind("identity_key", preKey.getIdentityKey()); + sql.bind("last_resort", preKey.isLastResort() ? 1 : 0); + } + }; + } + } + } + + + public static class PreKeyMapper implements ResultSetMapper { + @Override + public PreKey map(int i, ResultSet resultSet, StatementContext statementContext) + throws SQLException + { + return new PreKey(resultSet.getLong("id"), resultSet.getString("number"), + resultSet.getLong("key_id"), resultSet.getString("public_key"), + resultSet.getString("identity_key"), + resultSet.getInt("last_resort") == 1); + } + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccounts.java b/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccounts.java new file mode 100644 index 000000000..f54c165e7 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccounts.java @@ -0,0 +1,32 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + +import org.skife.jdbi.v2.sqlobject.Bind; +import org.skife.jdbi.v2.sqlobject.SqlQuery; +import org.skife.jdbi.v2.sqlobject.SqlUpdate; + +public interface PendingAccounts { + + @SqlUpdate("WITH upsert AS (UPDATE pending_accounts SET verification_code = :verification_code WHERE number = :number RETURNING *) " + + "INSERT INTO pending_accounts (number, verification_code) SELECT :number, :verification_code WHERE NOT EXISTS (SELECT * FROM upsert)") + void insert(@Bind("number") String number, @Bind("verification_code") String verificationCode); + + @SqlQuery("SELECT verification_code FROM pending_accounts WHERE number = :number") + String getCodeForNumber(@Bind("number") String number); + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccountsManager.java b/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccountsManager.java new file mode 100644 index 000000000..306fda280 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/storage/PendingAccountsManager.java @@ -0,0 +1,62 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.storage; + +import com.google.common.base.Optional; +import net.spy.memcached.MemcachedClient; + +public class PendingAccountsManager { + + private static final String MEMCACHE_PREFIX = "pending_account"; + + private final PendingAccounts pendingAccounts; + private final MemcachedClient memcachedClient; + + public PendingAccountsManager(PendingAccounts pendingAccounts, + MemcachedClient memcachedClient) + { + this.pendingAccounts = pendingAccounts; + this.memcachedClient = memcachedClient; + } + + public void store(String number, String code) { + if (memcachedClient != null) { + memcachedClient.set(MEMCACHE_PREFIX + number, 0, code); + } + + pendingAccounts.insert(number, code); + } + + public Optional getCodeForNumber(String number) { + String code = null; + + if (memcachedClient != null) { + code = (String)memcachedClient.get(MEMCACHE_PREFIX + number); + } + + if (code == null) { + code = pendingAccounts.getCodeForNumber(number); + + if (code != null && memcachedClient != null) { + memcachedClient.set(MEMCACHE_PREFIX + number, 0, code); + } + } + + if (code != null) return Optional.of(code); + else return Optional.absent(); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/Base64.java b/src/main/java/org/whispersystems/textsecuregcm/util/Base64.java new file mode 100644 index 000000000..4ab63dd75 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/Base64.java @@ -0,0 +1,2096 @@ +package org.whispersystems.textsecuregcm.util; + +/** + *

Encodes and decodes to and from Base64 notation.

+ *

Homepage: http://iharder.net/base64.

+ * + *

Example:

+ * + * String encoded = Base64.encode( myByteArray ); + *
+ * byte[] myByteArray = Base64.decode( encoded ); + * + *

The options parameter, which appears in a few places, is used to pass + * several pieces of information to the encoder. In the "higher level" methods such as + * encodeBytes( bytes, options ) the options parameter can be used to indicate such + * things as first gzipping the bytes before encoding them, not inserting linefeeds, + * and encoding using the URL-safe and Ordered dialects.

+ * + *

Note, according to RFC3548, + * Section 2.1, implementations should not add line feeds unless explicitly told + * to do so. I've got Base64 set to this behavior now, although earlier versions + * broke lines by default.

+ * + *

The constants defined in Base64 can be OR-ed together to combine options, so you + * might make a call like this:

+ * + * String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES ); + *

to compress the data before encoding it and then making the output have newline characters.

+ *

Also...

+ * String encoded = Base64.encodeBytes( crazyString.getBytes() ); + * + * + * + *

+ * Change Log: + *

+ *
    + *
  • v2.3.4 - Fixed bug when working with gzipped streams whereby flushing + * the Base64.OutputStream closed the Base64 encoding (by padding with equals + * signs) too soon. Also added an option to suppress the automatic decoding + * of gzipped streams. Also added experimental support for specifying a + * class loader when using the + * {@link #decodeToObject(java.lang.String, int, java.lang.ClassLoader)} + * method.
    • + *
  • v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java + * footprint with its CharEncoders and so forth. Fixed some javadocs that were + * inconsistent. Removed imports and specified things like java.io.IOException + * explicitly inline.
    • + *
  • v2.3.2 - Reduced memory footprint! Finally refined the "guessing" of how big the + * final encoded data will be so that the code doesn't have to create two output + * arrays: an oversized initial one and then a final, exact-sized one. Big win + * when using the {@link #encodeBytesToBytes(byte[])} family of methods (and not + * using the gzip options which uses a different mechanism with streams and stuff).
    • + *
  • v2.3.1 - Added {@link #encodeBytesToBytes(byte[], int, int, int)} and some + * similar helper methods to be more efficient with memory by not returning a + * String but just a byte array.
    • + *
  • v2.3 - This is not a drop-in replacement! This is two years of comments + * and bug fixes queued up and finally executed. Thanks to everyone who sent + * me stuff, and I'm sorry I wasn't able to distribute your fixes to everyone else. + * Much bad coding was cleaned up including throwing exceptions where necessary + * instead of returning null values or something similar. Here are some changes + * that may affect you: + *
      + *
    • Does not break lines, by default. This is to keep in compliance with + * RFC3548.
      • + *
    • Throws exceptions instead of returning null values. Because some operations + * (especially those that may permit the GZIP option) use IO streams, there + * is a possiblity of an java.io.IOException being thrown. After some discussion and + * thought, I've changed the behavior of the methods to throw java.io.IOExceptions + * rather than return null if ever there's an error. I think this is more + * appropriate, though it will require some changes to your code. Sorry, + * it should have been done this way to begin with.
      • + *
    • Removed all references to System.out, System.err, and the like. + * Shame on me. All I can say is sorry they were ever there.
      • + *
    • Throws NullPointerExceptions and IllegalArgumentExceptions as needed + * such as when passed arrays are null or offsets are invalid.
      • + *
    • Cleaned up as much javadoc as I could to avoid any javadoc warnings. + * This was especially annoying before for people who were thorough in their + * own projects and then had gobs of javadoc warnings on this file.
      • + *
    + *
  • v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug + * when using very small files (~< 40 bytes).
    • + *
  • v2.2 - Added some helper methods for encoding/decoding directly from + * one file to the next. Also added a main() method to support command line + * encoding/decoding from one file to the next. Also added these Base64 dialects: + *
      + *
    1. The default is RFC3548 format.
      2. + *
    2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates + * URL and file name friendly format as described in Section 4 of RFC3548. + * http://www.faqs.org/rfcs/rfc3548.html
      3. + *
    3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates + * URL and file name friendly format that preserves lexical ordering as described + * in http://www.faqs.org/qa/rfcc-1940.html
      4. + *
    + * Special thanks to Jim Kellerman at http://www.powerset.com/ + * for contributing the new Base64 dialects. + *
    • + * + *
  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added + * some convenience methods for reading and writing to and from files.
    • + *
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems + * with other encodings (like EBCDIC).
    • + *
  • v2.0.1 - Fixed an error when decoding a single byte, that is, when the + * encoded data was a single byte.
    • + *
  • v2.0 - I got rid of methods that used booleans to set options. + * Now everything is more consolidated and cleaner. The code now detects + * when data that's being decoded is gzip-compressed and will decompress it + * automatically. Generally things are cleaner. You'll probably have to + * change some method calls that you were making to support the new + * options format (ints that you "OR" together).
    • + *
  • v1.5.1 - Fixed bug when decompressing and decoding to a + * byte[] using decode( String s, boolean gzipCompressed ). + * Added the ability to "suspend" encoding in the Output Stream so + * you can turn on and off the encoding if you need to embed base64 + * data in an otherwise "normal" stream (like an XML file).
    • + *
  • v1.5 - Output stream pases on flush() command but doesn't do anything itself. + * This helps when using GZIP streams. + * Added the ability to GZip-compress objects before encoding them.
    • + *
  • v1.4 - Added helper methods to read/write files.
    • + *
  • v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
    • + *
  • v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream + * where last buffer being read, if not completely full, was not returned.
    • + *
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
    • + *
  • v1.3.3 - Fixed I/O streams which were totally messed up.
    • + *
+ * + *

+ * I am placing this code in the Public Domain. Do with it as you will. + * This software comes with no guarantees or warranties but with + * plenty of well-wishing instead! + * Please visit http://iharder.net/base64 + * periodically to check for updates or to contribute improvements. + *

+ * + * @author Robert Harder + * @author rob@iharder.net + * @version 2.3.3 + */ +public class Base64 +{ + +/* ******** P U B L I C F I E L D S ******** */ + + + /** No options specified. Value is zero. */ + public final static int NO_OPTIONS = 0; + + /** Specify encoding in first bit. Value is one. */ + public final static int ENCODE = 1; + + + /** Specify decoding in first bit. Value is zero. */ + public final static int DECODE = 0; + + + /** Specify that data should be gzip-compressed in second bit. Value is two. */ + public final static int GZIP = 2; + + /** Specify that gzipped data should not be automatically gunzipped. */ + public final static int DONT_GUNZIP = 4; + + + /** Do break lines when encoding. Value is 8. */ + public final static int DO_BREAK_LINES = 8; + + /** + * Encode using Base64-like encoding that is URL- and Filename-safe as described + * in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * It is important to note that data encoded this way is not officially valid Base64, + * or at the very least should not be called Base64 without also specifying that is + * was encoded using the URL- and Filename-safe dialect. + */ + public final static int URL_SAFE = 16; + + + /** + * Encode using the special "ordered" dialect of Base64 described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ + public final static int ORDERED = 32; + + +/* ******** P R I V A T E F I E L D S ******** */ + + + /** Maximum line length (76) of Base64 output. */ + private final static int MAX_LINE_LENGTH = 76; + + + /** The equals sign (=) as a byte. */ + private final static byte EQUALS_SIGN = (byte)'='; + + + /** The new line character (\n) as a byte. */ + private final static byte NEW_LINE = (byte)'\n'; + + + /** Preferred encoding. */ + private final static String PREFERRED_ENCODING = "US-ASCII"; + + + private final static byte WHITE_SPACE_ENC = -5; // Indicates white space in encoding + private final static byte EQUALS_SIGN_ENC = -1; // Indicates equals sign in encoding + + +/* ******** S T A N D A R D B A S E 6 4 A L P H A B E T ******** */ + + /** The 64 valid Base64 values. */ + /* Host platform me be something funny like EBCDIC, so we hardcode these values. */ + private final static byte[] _STANDARD_ALPHABET = { + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', + (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'+', (byte)'/' + }; + + + /** + * Translates a Base64 value to either its 6-bit reconstruction value + * or a negative number indicating some other meaning. + **/ + private final static byte[] _STANDARD_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + 62, // Plus sign at decimal 43 + -9,-9,-9, // Decimal 44 - 46 + 63, // Slash at decimal 47 + 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' + 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' + -9,-9,-9,-9,-9,-9, // Decimal 91 - 96 + 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' + 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' + -9,-9,-9,-9 // Decimal 123 - 126 + /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ + }; + + +/* ******** U R L S A F E B A S E 6 4 A L P H A B E T ******** */ + + /** + * Used in the URL- and Filename-safe dialect described in Section 4 of RFC3548: + * http://www.faqs.org/rfcs/rfc3548.html. + * Notice that the last two bytes become "hyphen" and "underscore" instead of "plus" and "slash." + */ + private final static byte[] _URL_SAFE_ALPHABET = { + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', (byte)'5', + (byte)'6', (byte)'7', (byte)'8', (byte)'9', (byte)'-', (byte)'_' + }; + + /** + * Used in decoding URL- and Filename-safe dialects of Base64. + */ + private final static byte[] _URL_SAFE_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 62, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 52,53,54,55,56,57,58,59,60,61, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 0,1,2,3,4,5,6,7,8,9,10,11,12,13, // Letters 'A' through 'N' + 14,15,16,17,18,19,20,21,22,23,24,25, // Letters 'O' through 'Z' + -9,-9,-9,-9, // Decimal 91 - 94 + 63, // Underscore at decimal 95 + -9, // Decimal 96 + 26,27,28,29,30,31,32,33,34,35,36,37,38, // Letters 'a' through 'm' + 39,40,41,42,43,44,45,46,47,48,49,50,51, // Letters 'n' through 'z' + -9,-9,-9,-9 // Decimal 123 - 126 + /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ + }; + + + +/* ******** O R D E R E D B A S E 6 4 A L P H A B E T ******** */ + + /** + * I don't get the point of this technique, but someone requested it, + * and it is described here: + * http://www.faqs.org/qa/rfcc-1940.html. + */ + private final static byte[] _ORDERED_ALPHABET = { + (byte)'-', + (byte)'0', (byte)'1', (byte)'2', (byte)'3', (byte)'4', + (byte)'5', (byte)'6', (byte)'7', (byte)'8', (byte)'9', + (byte)'A', (byte)'B', (byte)'C', (byte)'D', (byte)'E', (byte)'F', (byte)'G', + (byte)'H', (byte)'I', (byte)'J', (byte)'K', (byte)'L', (byte)'M', (byte)'N', + (byte)'O', (byte)'P', (byte)'Q', (byte)'R', (byte)'S', (byte)'T', (byte)'U', + (byte)'V', (byte)'W', (byte)'X', (byte)'Y', (byte)'Z', + (byte)'_', + (byte)'a', (byte)'b', (byte)'c', (byte)'d', (byte)'e', (byte)'f', (byte)'g', + (byte)'h', (byte)'i', (byte)'j', (byte)'k', (byte)'l', (byte)'m', (byte)'n', + (byte)'o', (byte)'p', (byte)'q', (byte)'r', (byte)'s', (byte)'t', (byte)'u', + (byte)'v', (byte)'w', (byte)'x', (byte)'y', (byte)'z' + }; + + /** + * Used in decoding the "ordered" dialect of Base64. + */ + private final static byte[] _ORDERED_DECODABET = { + -9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 0 - 8 + -5,-5, // Whitespace: Tab and Linefeed + -9,-9, // Decimal 11 - 12 + -5, // Whitespace: Carriage Return + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 14 - 26 + -9,-9,-9,-9,-9, // Decimal 27 - 31 + -5, // Whitespace: Space + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 33 - 42 + -9, // Plus sign at decimal 43 + -9, // Decimal 44 + 0, // Minus sign at decimal 45 + -9, // Decimal 46 + -9, // Slash at decimal 47 + 1,2,3,4,5,6,7,8,9,10, // Numbers zero through nine + -9,-9,-9, // Decimal 58 - 60 + -1, // Equals sign at decimal 61 + -9,-9,-9, // Decimal 62 - 64 + 11,12,13,14,15,16,17,18,19,20,21,22,23, // Letters 'A' through 'M' + 24,25,26,27,28,29,30,31,32,33,34,35,36, // Letters 'N' through 'Z' + -9,-9,-9,-9, // Decimal 91 - 94 + 37, // Underscore at decimal 95 + -9, // Decimal 96 + 38,39,40,41,42,43,44,45,46,47,48,49,50, // Letters 'a' through 'm' + 51,52,53,54,55,56,57,58,59,60,61,62,63, // Letters 'n' through 'z' + -9,-9,-9,-9 // Decimal 123 - 126 + /*,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 127 - 139 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 140 - 152 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 153 - 165 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 166 - 178 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 179 - 191 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 192 - 204 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 205 - 217 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 218 - 230 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9, // Decimal 231 - 243 + -9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9,-9 // Decimal 244 - 255 */ + }; + + +/* ******** D E T E R M I N E W H I C H A L H A B E T ******** */ + + + /** + * Returns one of the _SOMETHING_ALPHABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URLSAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getAlphabet( int options ) { + if ((options & URL_SAFE) == URL_SAFE) { + return _URL_SAFE_ALPHABET; + } else if ((options & ORDERED) == ORDERED) { + return _ORDERED_ALPHABET; + } else { + return _STANDARD_ALPHABET; + } + } // end getAlphabet + + + /** + * Returns one of the _SOMETHING_DECODABET byte arrays depending on + * the options specified. + * It's possible, though silly, to specify ORDERED and URL_SAFE + * in which case one of them will be picked, though there is + * no guarantee as to which one will be picked. + */ + private final static byte[] getDecodabet( int options ) { + if( (options & URL_SAFE) == URL_SAFE) { + return _URL_SAFE_DECODABET; + } else if ((options & ORDERED) == ORDERED) { + return _ORDERED_DECODABET; + } else { + return _STANDARD_DECODABET; + } + } // end getAlphabet + + + + /** Defeats instantiation. */ + private Base64(){} + + + + public static int getEncodedLengthWithoutPadding(int unencodedLength) { + int remainderBytes = unencodedLength % 3; + int paddingBytes = 0; + + if (remainderBytes != 0) + paddingBytes = 3 - remainderBytes; + + return (((int)((unencodedLength+2)/3))*4) - paddingBytes; + } + + public static int getEncodedBytesForTarget(int targetSize) { + return ((int)(targetSize * 3)) / 4; + } + + +/* ******** E N C O D I N G M E T H O D S ******** */ + + + /** + * Encodes up to the first three bytes of array threeBytes + * and returns a four-byte array in Base64 notation. + * The actual number of significant bytes in your array is + * given by numSigBytes. + * The array threeBytes needs only be as big as + * numSigBytes. + * Code can reuse a byte array by passing a four-byte array as b4. + * + * @param b4 A reusable byte array to reduce array instantiation + * @param threeBytes the array to convert + * @param numSigBytes the number of significant bytes in your array + * @return four byte array in Base64 notation. + * @since 1.5.1 + */ + private static byte[] encode3to4( byte[] b4, byte[] threeBytes, int numSigBytes, int options ) { + encode3to4( threeBytes, 0, numSigBytes, b4, 0, options ); + return b4; + } // end encode3to4 + + + /** + *

Encodes up to three bytes of the array source + * and writes the resulting four Base64 bytes to destination. + * The source and destination arrays can be manipulated + * anywhere along their length by specifying + * srcOffset and destOffset. + * This method does not check to make sure your arrays + * are large enough to accomodate srcOffset + 3 for + * the source array or destOffset + 4 for + * the destination array. + * The actual number of significant bytes in your array is + * given by numSigBytes.

+ *

This is the lowest level of the encoding methods with + * all possible parameters.

+ * + * @param source the array to convert + * @param srcOffset the index where conversion begins + * @param numSigBytes the number of significant bytes in your array + * @param destination the array to hold the conversion + * @param destOffset the index where output will be put + * @return the destination array + * @since 1.3 + */ + private static byte[] encode3to4( + byte[] source, int srcOffset, int numSigBytes, + byte[] destination, int destOffset, int options ) { + + byte[] ALPHABET = getAlphabet( options ); + + // 1 2 3 + // 01234567890123456789012345678901 Bit position + // --------000000001111111122222222 Array position from threeBytes + // --------| || || || | Six bit groups to index ALPHABET + // >>18 >>12 >> 6 >> 0 Right shift necessary + // 0x3f 0x3f 0x3f Additional AND + + // Create buffer with zero-padding if there are only one or two + // significant bytes passed in the array. + // We have to shift left 24 in order to flush out the 1's that appear + // when Java treats a value as negative that is cast from a byte to an int. + int inBuff = ( numSigBytes > 0 ? ((source[ srcOffset ] << 24) >>> 8) : 0 ) + | ( numSigBytes > 1 ? ((source[ srcOffset + 1 ] << 24) >>> 16) : 0 ) + | ( numSigBytes > 2 ? ((source[ srcOffset + 2 ] << 24) >>> 24) : 0 ); + + switch( numSigBytes ) + { + case 3: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; + destination[ destOffset + 3 ] = ALPHABET[ (inBuff ) & 0x3f ]; + return destination; + + case 2: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = ALPHABET[ (inBuff >>> 6) & 0x3f ]; + destination[ destOffset + 3 ] = EQUALS_SIGN; + return destination; + + case 1: + destination[ destOffset ] = ALPHABET[ (inBuff >>> 18) ]; + destination[ destOffset + 1 ] = ALPHABET[ (inBuff >>> 12) & 0x3f ]; + destination[ destOffset + 2 ] = EQUALS_SIGN; + destination[ destOffset + 3 ] = EQUALS_SIGN; + return destination; + + default: + return destination; + } // end switch + } // end encode3to4 + + + + /** + * Performs Base64 encoding on the raw ByteBuffer, + * writing it to the encoded ByteBuffer. + * This is an experimental feature. Currently it does not + * pass along any options (such as {@link #DO_BREAK_LINES} + * or {@link #GZIP}. + * + * @param raw input buffer + * @param encoded output buffer + * @since 2.3 + */ + public static void encode( java.nio.ByteBuffer raw, java.nio.ByteBuffer encoded ){ + byte[] raw3 = new byte[3]; + byte[] enc4 = new byte[4]; + + while( raw.hasRemaining() ){ + int rem = Math.min(3,raw.remaining()); + raw.get(raw3,0,rem); + Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS ); + encoded.put(enc4); + } // end input remaining + } + + + /** + * Performs Base64 encoding on the raw ByteBuffer, + * writing it to the encoded CharBuffer. + * This is an experimental feature. Currently it does not + * pass along any options (such as {@link #DO_BREAK_LINES} + * or {@link #GZIP}. + * + * @param raw input buffer + * @param encoded output buffer + * @since 2.3 + */ + public static void encode( java.nio.ByteBuffer raw, java.nio.CharBuffer encoded ){ + byte[] raw3 = new byte[3]; + byte[] enc4 = new byte[4]; + + while( raw.hasRemaining() ){ + int rem = Math.min(3,raw.remaining()); + raw.get(raw3,0,rem); + Base64.encode3to4(enc4, raw3, rem, Base64.NO_OPTIONS ); + for( int i = 0; i < 4; i++ ){ + encoded.put( (char)(enc4[i] & 0xFF) ); + } + } // end input remaining + } + + + + + /** + * Serializes an object and returns the Base64-encoded + * version of that serialized object. + * + *

As of v 2.3, if the object + * cannot be serialized or there is another error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * The object is not GZip-compressed before being encoded. + * + * @param serializableObject The object to encode + * @return The Base64-encoded object + * @throws java.io.IOException if there is an error + * @throws NullPointerException if serializedObject is null + * @since 1.4 + */ + public static String encodeObject( java.io.Serializable serializableObject ) + throws java.io.IOException { + return encodeObject( serializableObject, NO_OPTIONS ); + } // end encodeObject + + + + /** + * Serializes an object and returns the Base64-encoded + * version of that serialized object. + * + *

As of v 2.3, if the object + * cannot be serialized or there is another error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * The object is not GZip-compressed before being encoded. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *
+ *

+ * Example: encodeObject( myObj, Base64.GZIP ) or + *

+ * Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * @param serializableObject The object to encode + * @param options Specified options + * @return The Base64-encoded object + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @since 2.0 + */ + public static String encodeObject( java.io.Serializable serializableObject, int options ) + throws java.io.IOException { + + if( serializableObject == null ){ + throw new NullPointerException( "Cannot serialize a null object." ); + } // end if: null + + // Streams + java.io.ByteArrayOutputStream baos = null; + java.io.OutputStream b64os = null; + java.util.zip.GZIPOutputStream gzos = null; + java.io.ObjectOutputStream oos = null; + + + try { + // ObjectOutputStream -> (GZIP) -> Base64 -> ByteArrayOutputStream + baos = new java.io.ByteArrayOutputStream(); + b64os = new Base64.OutputStream( baos, ENCODE | options ); + if( (options & GZIP) != 0 ){ + // Gzip + gzos = new java.util.zip.GZIPOutputStream(b64os); + oos = new java.io.ObjectOutputStream( gzos ); + } else { + // Not gzipped + oos = new java.io.ObjectOutputStream( b64os ); + } + oos.writeObject( serializableObject ); + } // end try + catch( java.io.IOException e ) { + // Catch it and then throw it immediately so that + // the finally{} block is called for cleanup. + throw e; + } // end catch + finally { + try{ oos.close(); } catch( Exception e ){} + try{ gzos.close(); } catch( Exception e ){} + try{ b64os.close(); } catch( Exception e ){} + try{ baos.close(); } catch( Exception e ){} + } // end finally + + // Return value according to relevant encoding. + try { + return new String( baos.toByteArray(), PREFERRED_ENCODING ); + } // end try + catch (java.io.UnsupportedEncodingException uue){ + // Fall back to some Java default + return new String( baos.toByteArray() ); + } // end catch + + } // end encode + + + + /** + * Encodes a byte array into Base64 notation. + * Does not GZip-compress data. + * + * @param source The data to convert + * @return The data in Base64-encoded form + * @throws NullPointerException if source array is null + * @since 1.4 + */ + public static String encodeBytes( byte[] source ) { + // Since we're not going to have the GZIP encoding turned on, + // we're not going to have an java.io.IOException thrown, so + // we should not force the user to have to catch it. + String encoded = null; + try { + encoded = encodeBytes(source, 0, source.length, NO_OPTIONS); + } catch (java.io.IOException ex) { + assert false : ex.getMessage(); + } // end catch + assert encoded != null; + return encoded; + } // end encodeBytes + + + public static String encodeBytesWithoutPadding(byte[] source, int offset, int length) { + String encoded = null; + + try { + encoded = encodeBytes(source, offset, length, NO_OPTIONS); + } catch (java.io.IOException ex) { + assert false : ex.getMessage(); + } + + assert encoded != null; + + if (encoded.charAt(encoded.length()-2) == '=') return encoded.substring(0, encoded.length()-2); + else if (encoded.charAt(encoded.length()-1) == '=') return encoded.substring(0, encoded.length()-1); + else return encoded; + + } + + public static String encodeBytesWithoutPadding(byte[] source) { + return encodeBytesWithoutPadding(source, 0, source.length); + } + + + /** + * Encodes a byte array into Base64 notation. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *     Note: Technically, this makes your encoding non-compliant.
+     *
+ *

+ * Example: encodeBytes( myData, Base64.GZIP ) or + *

+ * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * + *

As of v 2.3, if there is an error with the GZIP stream, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @since 2.0 + */ + public static String encodeBytes( byte[] source, int options ) throws java.io.IOException { + return encodeBytes( source, 0, source.length, options ); + } // end encodeBytes + + + /** + * Encodes a byte array into Base64 notation. + * Does not GZip-compress data. + * + *

As of v 2.3, if there is an error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @return The Base64-encoded data as a String + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 1.4 + */ + public static String encodeBytes( byte[] source, int off, int len ) { + // Since we're not going to have the GZIP encoding turned on, + // we're not going to have an java.io.IOException thrown, so + // we should not force the user to have to catch it. + String encoded = null; + try { + encoded = encodeBytes( source, off, len, NO_OPTIONS ); + } catch (java.io.IOException ex) { + assert false : ex.getMessage(); + } // end catch + assert encoded != null; + return encoded; + } // end encodeBytes + + + + /** + * Encodes a byte array into Base64 notation. + *

+ * Example options:

+     *   GZIP: gzip-compresses object before encoding it.
+     *   DO_BREAK_LINES: break lines at 76 characters
+     *     Note: Technically, this makes your encoding non-compliant.
+     *
+ *

+ * Example: encodeBytes( myData, Base64.GZIP ) or + *

+ * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) + * + * + *

As of v 2.3, if there is an error with the GZIP stream, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned a null value, but + * in retrospect that's a pretty poor way to handle it.

+ * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 2.0 + */ + public static String encodeBytes( byte[] source, int off, int len, int options ) throws java.io.IOException { + byte[] encoded = encodeBytesToBytes( source, off, len, options ); + + // Return value according to relevant encoding. + try { + return new String( encoded, PREFERRED_ENCODING ); + } // end try + catch (java.io.UnsupportedEncodingException uue) { + return new String( encoded ); + } // end catch + + } // end encodeBytes + + + + + /** + * Similar to {@link #encodeBytes(byte[])} but returns + * a byte array instead of instantiating a String. This is more efficient + * if you're working with I/O streams and have large data sets to encode. + * + * + * @param source The data to convert + * @return The Base64-encoded data as a byte[] (of ASCII characters) + * @throws NullPointerException if source array is null + * @since 2.3.1 + */ + public static byte[] encodeBytesToBytes( byte[] source ) { + byte[] encoded = null; + try { + encoded = encodeBytesToBytes( source, 0, source.length, Base64.NO_OPTIONS ); + } catch( java.io.IOException ex ) { + assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage(); + } + return encoded; + } + + + /** + * Similar to {@link #encodeBytes(byte[], int, int, int)} but returns + * a byte array instead of instantiating a String. This is more efficient + * if you're working with I/O streams and have large data sets to encode. + * + * + * @param source The data to convert + * @param off Offset in array where conversion should begin + * @param len Length of data to convert + * @param options Specified options + * @return The Base64-encoded data as a String + * @see Base64#GZIP + * @see Base64#DO_BREAK_LINES + * @throws java.io.IOException if there is an error + * @throws NullPointerException if source array is null + * @throws IllegalArgumentException if source array, offset, or length are invalid + * @since 2.3.1 + */ + public static byte[] encodeBytesToBytes( byte[] source, int off, int len, int options ) throws java.io.IOException { + + if( source == null ){ + throw new NullPointerException( "Cannot serialize a null array." ); + } // end if: null + + if( off < 0 ){ + throw new IllegalArgumentException( "Cannot have negative offset: " + off ); + } // end if: off < 0 + + if( len < 0 ){ + throw new IllegalArgumentException( "Cannot have length offset: " + len ); + } // end if: len < 0 + + if( off + len > source.length ){ + throw new IllegalArgumentException( + String.format( "Cannot have offset of %d and length of %d with array of length %d", off,len,source.length)); + } // end if: off < 0 + + + + // Compress? + if( (options & GZIP) != 0 ) { + java.io.ByteArrayOutputStream baos = null; + java.util.zip.GZIPOutputStream gzos = null; + Base64.OutputStream b64os = null; + + try { + // GZip -> Base64 -> ByteArray + baos = new java.io.ByteArrayOutputStream(); + b64os = new Base64.OutputStream( baos, ENCODE | options ); + gzos = new java.util.zip.GZIPOutputStream( b64os ); + + gzos.write( source, off, len ); + gzos.close(); + } // end try + catch( java.io.IOException e ) { + // Catch it and then throw it immediately so that + // the finally{} block is called for cleanup. + throw e; + } // end catch + finally { + try{ gzos.close(); } catch( Exception e ){} + try{ b64os.close(); } catch( Exception e ){} + try{ baos.close(); } catch( Exception e ){} + } // end finally + + return baos.toByteArray(); + } // end if: compress + + // Else, don't compress. Better not to use streams at all then. + else { + boolean breakLines = (options & DO_BREAK_LINES) > 0; + + //int len43 = len * 4 / 3; + //byte[] outBuff = new byte[ ( len43 ) // Main 4:3 + // + ( (len % 3) > 0 ? 4 : 0 ) // Account for padding + // + (breakLines ? ( len43 / MAX_LINE_LENGTH ) : 0) ]; // New lines + // Try to determine more precisely how big the array needs to be. + // If we get it right, we don't have to do an array copy, and + // we save a bunch of memory. + int encLen = ( len / 3 ) * 4 + ( len % 3 > 0 ? 4 : 0 ); // Bytes needed for actual encoding + if( breakLines ){ + encLen += encLen / MAX_LINE_LENGTH; // Plus extra newline characters + } + byte[] outBuff = new byte[ encLen ]; + + + int d = 0; + int e = 0; + int len2 = len - 2; + int lineLength = 0; + for( ; d < len2; d+=3, e+=4 ) { + encode3to4( source, d+off, 3, outBuff, e, options ); + + lineLength += 4; + if( breakLines && lineLength >= MAX_LINE_LENGTH ) + { + outBuff[e+4] = NEW_LINE; + e++; + lineLength = 0; + } // end if: end of line + } // en dfor: each piece of array + + if( d < len ) { + encode3to4( source, d+off, len - d, outBuff, e, options ); + e += 4; + } // end if: some padding needed + + + // Only resize array if we didn't guess it right. + if( e < outBuff.length - 1 ){ + byte[] finalOut = new byte[e]; + System.arraycopy(outBuff,0, finalOut,0,e); + //System.err.println("Having to resize array from " + outBuff.length + " to " + e ); + return finalOut; + } else { + //System.err.println("No need to resize array."); + return outBuff; + } + + } // end else: don't compress + + } // end encodeBytesToBytes + + + + + +/* ******** D E C O D I N G M E T H O D S ******** */ + + + /** + * Decodes four bytes from array source + * and writes the resulting bytes (up to three of them) + * to destination. + * The source and destination arrays can be manipulated + * anywhere along their length by specifying + * srcOffset and destOffset. + * This method does not check to make sure your arrays + * are large enough to accomodate srcOffset + 4 for + * the source array or destOffset + 3 for + * the destination array. + * This method returns the actual number of bytes that + * were converted from the Base64 encoding. + *

This is the lowest level of the decoding methods with + * all possible parameters.

+ * + * + * @param source the array to convert + * @param srcOffset the index where conversion begins + * @param destination the array to hold the conversion + * @param destOffset the index where output will be put + * @param options alphabet type is pulled from this (standard, url-safe, ordered) + * @return the number of decoded bytes converted + * @throws NullPointerException if source or destination arrays are null + * @throws IllegalArgumentException if srcOffset or destOffset are invalid + * or there is not enough room in the array. + * @since 1.3 + */ + private static int decode4to3( + byte[] source, int srcOffset, + byte[] destination, int destOffset, int options ) { + + // Lots of error checking and exception throwing + if( source == null ){ + throw new NullPointerException( "Source array was null." ); + } // end if + if( destination == null ){ + throw new NullPointerException( "Destination array was null." ); + } // end if + if( srcOffset < 0 || srcOffset + 3 >= source.length ){ + throw new IllegalArgumentException( String.format( + "Source array with length %d cannot have offset of %d and still process four bytes.", source.length, srcOffset ) ); + } // end if + if( destOffset < 0 || destOffset +2 >= destination.length ){ + throw new IllegalArgumentException( String.format( + "Destination array with length %d cannot have offset of %d and still store three bytes.", destination.length, destOffset ) ); + } // end if + + + byte[] DECODABET = getDecodabet( options ); + + // Example: Dk== + if( source[ srcOffset + 2] == EQUALS_SIGN ) { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1] ] << 24 ) >>> 12 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1] ] & 0xFF ) << 12 ); + + destination[ destOffset ] = (byte)( outBuff >>> 16 ); + return 1; + } + + // Example: DkL= + else if( source[ srcOffset + 3 ] == EQUALS_SIGN ) { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) + // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) + | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6 ); + + destination[ destOffset ] = (byte)( outBuff >>> 16 ); + destination[ destOffset + 1 ] = (byte)( outBuff >>> 8 ); + return 2; + } + + // Example: DkLE + else { + // Two ways to do the same thing. Don't know which way I like best. + //int outBuff = ( ( DECODABET[ source[ srcOffset ] ] << 24 ) >>> 6 ) + // | ( ( DECODABET[ source[ srcOffset + 1 ] ] << 24 ) >>> 12 ) + // | ( ( DECODABET[ source[ srcOffset + 2 ] ] << 24 ) >>> 18 ) + // | ( ( DECODABET[ source[ srcOffset + 3 ] ] << 24 ) >>> 24 ); + int outBuff = ( ( DECODABET[ source[ srcOffset ] ] & 0xFF ) << 18 ) + | ( ( DECODABET[ source[ srcOffset + 1 ] ] & 0xFF ) << 12 ) + | ( ( DECODABET[ source[ srcOffset + 2 ] ] & 0xFF ) << 6) + | ( ( DECODABET[ source[ srcOffset + 3 ] ] & 0xFF ) ); + + + destination[ destOffset ] = (byte)( outBuff >> 16 ); + destination[ destOffset + 1 ] = (byte)( outBuff >> 8 ); + destination[ destOffset + 2 ] = (byte)( outBuff ); + + return 3; + } + } // end decodeToBytes + + + + + + /** + * Low-level access to decoding ASCII characters in + * the form of a byte array. Ignores GUNZIP option, if + * it's set. This is not generally a recommended method, + * although it is used internally as part of the decoding process. + * Special case: if len = 0, an empty array is returned. Still, + * if you need more speed and reduced memory footprint (and aren't + * gzipping), consider this method. + * + * @param source The Base64 encoded data + * @return decoded data + * @since 2.3.1 + */ + public static byte[] decode( byte[] source ){ + byte[] decoded = null; + try { + decoded = decode( source, 0, source.length, Base64.NO_OPTIONS ); + } catch( java.io.IOException ex ) { + assert false : "IOExceptions only come from GZipping, which is turned off: " + ex.getMessage(); + } + return decoded; + } + + + /** + * Low-level access to decoding ASCII characters in + * the form of a byte array. Ignores GUNZIP option, if + * it's set. This is not generally a recommended method, + * although it is used internally as part of the decoding process. + * Special case: if len = 0, an empty array is returned. Still, + * if you need more speed and reduced memory footprint (and aren't + * gzipping), consider this method. + * + * @param source The Base64 encoded data + * @param off The offset of where to begin decoding + * @param len The length of characters to decode + * @param options Can specify options such as alphabet type to use + * @return decoded data + * @throws java.io.IOException If bogus characters exist in source data + * @since 1.3 + */ + public static byte[] decode( byte[] source, int off, int len, int options ) + throws java.io.IOException { + + // Lots of error checking and exception throwing + if( source == null ){ + throw new NullPointerException( "Cannot decode null source array." ); + } // end if + if( off < 0 || off + len > source.length ){ + throw new IllegalArgumentException( String.format( + "Source array with length %d cannot have offset of %d and process %d bytes.", source.length, off, len ) ); + } // end if + + if( len == 0 ){ + return new byte[0]; + }else if( len < 4 ){ + throw new IllegalArgumentException( + "Base64-encoded string must have at least four characters, but length specified was " + len ); + } // end if + + byte[] DECODABET = getDecodabet( options ); + + int len34 = len * 3 / 4; // Estimate on array size + byte[] outBuff = new byte[ len34 ]; // Upper limit on size of output + int outBuffPosn = 0; // Keep track of where we're writing + + byte[] b4 = new byte[4]; // Four byte buffer from source, eliminating white space + int b4Posn = 0; // Keep track of four byte input buffer + int i = 0; // Source array counter + byte sbiCrop = 0; // Low seven bits (ASCII) of input + byte sbiDecode = 0; // Special value from DECODABET + + for( i = off; i < off+len; i++ ) { // Loop through source + + sbiCrop = (byte)(source[i] & 0x7f); // Only the low seven bits + sbiDecode = DECODABET[ sbiCrop ]; // Special value + + // White space, Equals sign, or legit Base64 character + // Note the values such as -5 and -9 in the + // DECODABETs at the top of the file. + if( sbiDecode >= WHITE_SPACE_ENC ) { + if( sbiDecode >= EQUALS_SIGN_ENC ) { + b4[ b4Posn++ ] = sbiCrop; // Save non-whitespace + if( b4Posn > 3 ) { // Time to decode? + outBuffPosn += decode4to3( b4, 0, outBuff, outBuffPosn, options ); + b4Posn = 0; + + // If that was the equals sign, break out of 'for' loop + if( sbiCrop == EQUALS_SIGN ) { + break; + } // end if: equals sign + } // end if: quartet built + } // end if: equals sign or better + } // end if: white space, equals sign or better + else { + // There's a bad input character in the Base64 stream. + throw new java.io.IOException( String.format( + "Bad Base64 input character '%c' in array position %d", source[i], i ) ); + } // end else: + } // each input character + + byte[] out = new byte[ outBuffPosn ]; + System.arraycopy( outBuff, 0, out, 0, outBuffPosn ); + return out; + } // end decode + + + + + /** + * Decodes data from Base64 notation, automatically + * detecting gzip-compressed data and decompressing it. + * + * @param s the string to decode + * @return the decoded data + * @throws java.io.IOException If there is a problem + * @since 1.4 + */ + public static byte[] decode( String s ) throws java.io.IOException { + return decode( s, NO_OPTIONS ); + } + + + public static byte[] decodeWithoutPadding(String source) throws java.io.IOException { + int padding = source.length() % 4; + + if (padding == 1) source = source + "="; + else if (padding == 2) source = source + "=="; + else if (padding == 3) source = source + "="; + + return decode(source); + } + + + + /** + * Decodes data from Base64 notation, automatically + * detecting gzip-compressed data and decompressing it. + * + * @param s the string to decode + * @param options encode options such as URL_SAFE + * @return the decoded data + * @throws java.io.IOException if there is an error + * @throws NullPointerException if s is null + * @since 1.4 + */ + public static byte[] decode( String s, int options ) throws java.io.IOException { + + if( s == null ){ + throw new NullPointerException( "Input string was null." ); + } // end if + + byte[] bytes; + try { + bytes = s.getBytes( PREFERRED_ENCODING ); + } // end try + catch( java.io.UnsupportedEncodingException uee ) { + bytes = s.getBytes(); + } // end catch + // + + // Decode + bytes = decode( bytes, 0, bytes.length, options ); + + // Check to see if it's gzip-compressed + // GZIP Magic Two-Byte Number: 0x8b1f (35615) + boolean dontGunzip = (options & DONT_GUNZIP) != 0; + if( (bytes != null) && (bytes.length >= 4) && (!dontGunzip) ) { + + int head = ((int)bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00); + if( java.util.zip.GZIPInputStream.GZIP_MAGIC == head ) { + java.io.ByteArrayInputStream bais = null; + java.util.zip.GZIPInputStream gzis = null; + java.io.ByteArrayOutputStream baos = null; + byte[] buffer = new byte[2048]; + int length = 0; + + try { + baos = new java.io.ByteArrayOutputStream(); + bais = new java.io.ByteArrayInputStream( bytes ); + gzis = new java.util.zip.GZIPInputStream( bais ); + + while( ( length = gzis.read( buffer ) ) >= 0 ) { + baos.write(buffer,0,length); + } // end while: reading input + + // No error? Get new bytes. + bytes = baos.toByteArray(); + + } // end try + catch( java.io.IOException e ) { + e.printStackTrace(); + // Just return originally-decoded bytes + } // end catch + finally { + try{ baos.close(); } catch( Exception e ){} + try{ gzis.close(); } catch( Exception e ){} + try{ bais.close(); } catch( Exception e ){} + } // end finally + + } // end if: gzipped + } // end if: bytes.length >= 2 + + return bytes; + } // end decode + + + + /** + * Attempts to decode Base64 data and deserialize a Java + * Object within. Returns null if there was an error. + * + * @param encodedObject The Base64 data to decode + * @return The decoded and deserialized object + * @throws NullPointerException if encodedObject is null + * @throws java.io.IOException if there is a general error + * @throws ClassNotFoundException if the decoded object is of a + * class that cannot be found by the JVM + * @since 1.5 + */ + public static Object decodeToObject( String encodedObject ) + throws java.io.IOException, java.lang.ClassNotFoundException { + return decodeToObject(encodedObject,NO_OPTIONS,null); + } + + + /** + * Attempts to decode Base64 data and deserialize a Java + * Object within. Returns null if there was an error. + * If loader is not null, it will be the class loader + * used when deserializing. + * + * @param encodedObject The Base64 data to decode + * @param options Various parameters related to decoding + * @param loader Optional class loader to use in deserializing classes. + * @return The decoded and deserialized object + * @throws NullPointerException if encodedObject is null + * @throws java.io.IOException if there is a general error + * @throws ClassNotFoundException if the decoded object is of a + * class that cannot be found by the JVM + * @since 2.3.4 + */ + public static Object decodeToObject( + String encodedObject, int options, final ClassLoader loader ) + throws java.io.IOException, java.lang.ClassNotFoundException { + + // Decode and gunzip if necessary + byte[] objBytes = decode( encodedObject, options ); + + java.io.ByteArrayInputStream bais = null; + java.io.ObjectInputStream ois = null; + Object obj = null; + + try { + bais = new java.io.ByteArrayInputStream( objBytes ); + + // If no custom class loader is provided, use Java's builtin OIS. + if( loader == null ){ + ois = new java.io.ObjectInputStream( bais ); + } // end if: no loader provided + + // Else make a customized object input stream that uses + // the provided class loader. + else { + ois = new java.io.ObjectInputStream(bais){ + @Override + public Class resolveClass(java.io.ObjectStreamClass streamClass) + throws java.io.IOException, ClassNotFoundException { + Class c = Class.forName(streamClass.getName(), false, loader); + if( c == null ){ + return super.resolveClass(streamClass); + } else { + return c; // Class loader knows of this class. + } // end else: not null + } // end resolveClass + }; // end ois + } // end else: no custom class loader + + obj = ois.readObject(); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw in order to execute finally{} + } // end catch + catch( java.lang.ClassNotFoundException e ) { + throw e; // Catch and throw in order to execute finally{} + } // end catch + finally { + try{ bais.close(); } catch( Exception e ){} + try{ ois.close(); } catch( Exception e ){} + } // end finally + + return obj; + } // end decodeObject + + + + /** + * Convenience method for encoding data to a file. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param dataToEncode byte array of data to encode in base64 form + * @param filename Filename for saving encoded data + * @throws java.io.IOException if there is an error + * @throws NullPointerException if dataToEncode is null + * @since 2.1 + */ + public static void encodeToFile( byte[] dataToEncode, String filename ) + throws java.io.IOException { + + if( dataToEncode == null ){ + throw new NullPointerException( "Data to encode was null." ); + } // end iff + + Base64.OutputStream bos = null; + try { + bos = new Base64.OutputStream( + new java.io.FileOutputStream( filename ), Base64.ENCODE ); + bos.write( dataToEncode ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw to execute finally{} block + } // end catch: java.io.IOException + finally { + try{ bos.close(); } catch( Exception e ){} + } // end finally + + } // end encodeToFile + + + /** + * Convenience method for decoding data to a file. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param dataToDecode Base64-encoded data as a string + * @param filename Filename for saving decoded data + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static void decodeToFile( String dataToDecode, String filename ) + throws java.io.IOException { + + Base64.OutputStream bos = null; + try{ + bos = new Base64.OutputStream( + new java.io.FileOutputStream( filename ), Base64.DECODE ); + bos.write( dataToDecode.getBytes( PREFERRED_ENCODING ) ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and throw to execute finally{} block + } // end catch: java.io.IOException + finally { + try{ bos.close(); } catch( Exception e ){} + } // end finally + + } // end decodeToFile + + + + + /** + * Convenience method for reading a base64-encoded + * file and decoding it. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param filename Filename for reading encoded data + * @return decoded byte array + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static byte[] decodeFromFile( String filename ) + throws java.io.IOException { + + byte[] decodedData = null; + Base64.InputStream bis = null; + try + { + // Set up some useful variables + java.io.File file = new java.io.File( filename ); + byte[] buffer = null; + int length = 0; + int numBytes = 0; + + // Check for size of file + if( file.length() > Integer.MAX_VALUE ) + { + throw new java.io.IOException( "File is too big for this convenience method (" + file.length() + " bytes)." ); + } // end if: file too big for int index + buffer = new byte[ (int)file.length() ]; + + // Open a stream + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream( file ) ), Base64.DECODE ); + + // Read until done + while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) { + length += numBytes; + } // end while + + // Save in a variable to return + decodedData = new byte[ length ]; + System.arraycopy( buffer, 0, decodedData, 0, length ); + + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch: java.io.IOException + finally { + try{ bis.close(); } catch( Exception e) {} + } // end finally + + return decodedData; + } // end decodeFromFile + + + + /** + * Convenience method for reading a binary file + * and base64-encoding it. + * + *

As of v 2.3, if there is a error, + * the method will throw an java.io.IOException. This is new to v2.3! + * In earlier versions, it just returned false, but + * in retrospect that's a pretty poor way to handle it.

+ * + * @param filename Filename for reading binary data + * @return base64-encoded string + * @throws java.io.IOException if there is an error + * @since 2.1 + */ + public static String encodeFromFile( String filename ) + throws java.io.IOException { + + String encodedData = null; + Base64.InputStream bis = null; + try + { + // Set up some useful variables + java.io.File file = new java.io.File( filename ); + byte[] buffer = new byte[ Math.max((int)(file.length() * 1.4),40) ]; // Need max() for math on small files (v2.2.1) + int length = 0; + int numBytes = 0; + + // Open a stream + bis = new Base64.InputStream( + new java.io.BufferedInputStream( + new java.io.FileInputStream( file ) ), Base64.ENCODE ); + + // Read until done + while( ( numBytes = bis.read( buffer, length, 4096 ) ) >= 0 ) { + length += numBytes; + } // end while + + // Save in a variable to return + encodedData = new String( buffer, 0, length, Base64.PREFERRED_ENCODING ); + + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch: java.io.IOException + finally { + try{ bis.close(); } catch( Exception e) {} + } // end finally + + return encodedData; + } // end encodeFromFile + + /** + * Reads infile and encodes it to outfile. + * + * @param infile Input file + * @param outfile Output file + * @throws java.io.IOException if there is an error + * @since 2.2 + */ + public static void encodeFileToFile( String infile, String outfile ) + throws java.io.IOException { + + String encoded = Base64.encodeFromFile( infile ); + java.io.OutputStream out = null; + try{ + out = new java.io.BufferedOutputStream( + new java.io.FileOutputStream( outfile ) ); + out.write( encoded.getBytes("US-ASCII") ); // Strict, 7-bit output. + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch + finally { + try { out.close(); } + catch( Exception ex ){} + } // end finally + } // end encodeFileToFile + + + /** + * Reads infile and decodes it to outfile. + * + * @param infile Input file + * @param outfile Output file + * @throws java.io.IOException if there is an error + * @since 2.2 + */ + public static void decodeFileToFile( String infile, String outfile ) + throws java.io.IOException { + + byte[] decoded = Base64.decodeFromFile( infile ); + java.io.OutputStream out = null; + try{ + out = new java.io.BufferedOutputStream( + new java.io.FileOutputStream( outfile ) ); + out.write( decoded ); + } // end try + catch( java.io.IOException e ) { + throw e; // Catch and release to execute finally{} + } // end catch + finally { + try { out.close(); } + catch( Exception ex ){} + } // end finally + } // end decodeFileToFile + + + /* ******** I N N E R C L A S S I N P U T S T R E A M ******** */ + + + + /** + * A {@link Base64.InputStream} will read data from another + * java.io.InputStream, given in the constructor, + * and encode/decode to/from Base64 notation on the fly. + * + * @see Base64 + * @since 1.3 + */ + public static class InputStream extends java.io.FilterInputStream { + + private boolean encode; // Encoding or decoding + private int position; // Current position in the buffer + private byte[] buffer; // Small buffer holding converted data + private int bufferLength; // Length of buffer (3 or 4) + private int numSigBytes; // Number of meaningful bytes in the buffer + private int lineLength; + private boolean breakLines; // Break lines at less than 80 characters + private int options; // Record options used to create the stream. + private byte[] decodabet; // Local copies to avoid extra method calls + + + /** + * Constructs a {@link Base64.InputStream} in DECODE mode. + * + * @param in the java.io.InputStream from which to read data. + * @since 1.3 + */ + public InputStream( java.io.InputStream in ) { + this( in, DECODE ); + } // end constructor + + + /** + * Constructs a {@link Base64.InputStream} in + * either ENCODE or DECODE mode. + *

+ * Valid options:

+         *   ENCODE or DECODE: Encode or Decode as data is read.
+         *   DO_BREAK_LINES: break lines at 76 characters
+         *     (only meaningful when encoding)
+         *
+ *

+ * Example: new Base64.InputStream( in, Base64.DECODE ) + * + * + * @param in the java.io.InputStream from which to read data. + * @param options Specified options + * @see Base64#ENCODE + * @see Base64#DECODE + * @see Base64#DO_BREAK_LINES + * @since 2.0 + */ + public InputStream( java.io.InputStream in, int options ) { + + super( in ); + this.options = options; // Record for later + this.breakLines = (options & DO_BREAK_LINES) > 0; + this.encode = (options & ENCODE) > 0; + this.bufferLength = encode ? 4 : 3; + this.buffer = new byte[ bufferLength ]; + this.position = -1; + this.lineLength = 0; + this.decodabet = getDecodabet(options); + } // end constructor + + /** + * Reads enough of the input stream to convert + * to/from Base64 and returns the next byte. + * + * @return next byte + * @since 1.3 + */ + @Override + public int read() throws java.io.IOException { + + // Do we need to get data? + if( position < 0 ) { + if( encode ) { + byte[] b3 = new byte[3]; + int numBinaryBytes = 0; + for( int i = 0; i < 3; i++ ) { + int b = in.read(); + + // If end of stream, b is -1. + if( b >= 0 ) { + b3[i] = (byte)b; + numBinaryBytes++; + } else { + break; // out of for loop + } // end else: end of stream + + } // end for: each needed input byte + + if( numBinaryBytes > 0 ) { + encode3to4( b3, 0, numBinaryBytes, buffer, 0, options ); + position = 0; + numSigBytes = 4; + } // end if: got data + else { + return -1; // Must be end of stream + } // end else + } // end if: encoding + + // Else decoding + else { + byte[] b4 = new byte[4]; + int i = 0; + for( i = 0; i < 4; i++ ) { + // Read four "meaningful" bytes: + int b = 0; + do{ b = in.read(); } + while( b >= 0 && decodabet[ b & 0x7f ] <= WHITE_SPACE_ENC ); + + if( b < 0 ) { + break; // Reads a -1 if end of stream + } // end if: end of stream + + b4[i] = (byte)b; + } // end for: each needed input byte + + if( i == 4 ) { + numSigBytes = decode4to3( b4, 0, buffer, 0, options ); + position = 0; + } // end if: got four characters + else if( i == 0 ){ + return -1; + } // end else if: also padded correctly + else { + // Must have broken out from above. + throw new java.io.IOException( "Improperly padded Base64 input." ); + } // end + + } // end else: decode + } // end else: get data + + // Got data? + if( position >= 0 ) { + // End of relevant data? + if( /*!encode &&*/ position >= numSigBytes ){ + return -1; + } // end if: got data + + if( encode && breakLines && lineLength >= MAX_LINE_LENGTH ) { + lineLength = 0; + return '\n'; + } // end if + else { + lineLength++; // This isn't important when decoding + // but throwing an extra "if" seems + // just as wasteful. + + int b = buffer[ position++ ]; + + if( position >= bufferLength ) { + position = -1; + } // end if: end + + return b & 0xFF; // This is how you "cast" a byte that's + // intended to be unsigned. + } // end else + } // end if: position >= 0 + + // Else error + else { + throw new java.io.IOException( "Error in Base64 code reading stream." ); + } // end else + } // end read + + + /** + * Calls {@link #read()} repeatedly until the end of stream + * is reached or len bytes are read. + * Returns number of bytes read into array or -1 if + * end of stream is encountered. + * + * @param dest array to hold values + * @param off offset for array + * @param len max number of bytes to read into array + * @return bytes read into array or -1 if end of stream is encountered. + * @since 1.3 + */ + @Override + public int read( byte[] dest, int off, int len ) + throws java.io.IOException { + int i; + int b; + for( i = 0; i < len; i++ ) { + b = read(); + + if( b >= 0 ) { + dest[off + i] = (byte) b; + } + else if( i == 0 ) { + return -1; + } + else { + break; // Out of 'for' loop + } // Out of 'for' loop + } // end for: each byte read + return i; + } // end read + + } // end inner class InputStream + + + + + + + /* ******** I N N E R C L A S S O U T P U T S T R E A M ******** */ + + + + /** + * A {@link Base64.OutputStream} will write data to another + * java.io.OutputStream, given in the constructor, + * and encode/decode to/from Base64 notation on the fly. + * + * @see Base64 + * @since 1.3 + */ + public static class OutputStream extends java.io.FilterOutputStream { + + private boolean encode; + private int position; + private byte[] buffer; + private int bufferLength; + private int lineLength; + private boolean breakLines; + private byte[] b4; // Scratch used in a few places + private boolean suspendEncoding; + private int options; // Record for later + private byte[] decodabet; // Local copies to avoid extra method calls + + /** + * Constructs a {@link Base64.OutputStream} in ENCODE mode. + * + * @param out the java.io.OutputStream to which data will be written. + * @since 1.3 + */ + public OutputStream( java.io.OutputStream out ) { + this( out, ENCODE ); + } // end constructor + + + /** + * Constructs a {@link Base64.OutputStream} in + * either ENCODE or DECODE mode. + *

+ * Valid options:

+         *   ENCODE or DECODE: Encode or Decode as data is read.
+         *   DO_BREAK_LINES: don't break lines at 76 characters
+         *     (only meaningful when encoding)
+         *
+ *

+ * Example: new Base64.OutputStream( out, Base64.ENCODE ) + * + * @param out the java.io.OutputStream to which data will be written. + * @param options Specified options. + * @see Base64#ENCODE + * @see Base64#DECODE + * @see Base64#DO_BREAK_LINES + * @since 1.3 + */ + public OutputStream( java.io.OutputStream out, int options ) { + super( out ); + this.breakLines = (options & DO_BREAK_LINES) != 0; + this.encode = (options & ENCODE) != 0; + this.bufferLength = encode ? 3 : 4; + this.buffer = new byte[ bufferLength ]; + this.position = 0; + this.lineLength = 0; + this.suspendEncoding = false; + this.b4 = new byte[4]; + this.options = options; + this.decodabet = getDecodabet(options); + } // end constructor + + + /** + * Writes the byte to the output stream after + * converting to/from Base64 notation. + * When encoding, bytes are buffered three + * at a time before the output stream actually + * gets a write() call. + * When decoding, bytes are buffered four + * at a time. + * + * @param theByte the byte to write + * @since 1.3 + */ + @Override + public void write(int theByte) + throws java.io.IOException { + // Encoding suspended? + if( suspendEncoding ) { + this.out.write( theByte ); + return; + } // end if: supsended + + // Encode? + if( encode ) { + buffer[ position++ ] = (byte)theByte; + if( position >= bufferLength ) { // Enough to encode. + + this.out.write( encode3to4( b4, buffer, bufferLength, options ) ); + + lineLength += 4; + if( breakLines && lineLength >= MAX_LINE_LENGTH ) { + this.out.write( NEW_LINE ); + lineLength = 0; + } // end if: end of line + + position = 0; + } // end if: enough to output + } // end if: encoding + + // Else, Decoding + else { + // Meaningful Base64 character? + if( decodabet[ theByte & 0x7f ] > WHITE_SPACE_ENC ) { + buffer[ position++ ] = (byte)theByte; + if( position >= bufferLength ) { // Enough to output. + + int len = Base64.decode4to3( buffer, 0, b4, 0, options ); + out.write( b4, 0, len ); + position = 0; + } // end if: enough to output + } // end if: meaningful base64 character + else if( decodabet[ theByte & 0x7f ] != WHITE_SPACE_ENC ) { + throw new java.io.IOException( "Invalid character in Base64 data." ); + } // end else: not white space either + } // end else: decoding + } // end write + + + + /** + * Calls {@link #write(int)} repeatedly until len + * bytes are written. + * + * @param theBytes array from which to read bytes + * @param off offset for array + * @param len max number of bytes to read into array + * @since 1.3 + */ + @Override + public void write( byte[] theBytes, int off, int len ) + throws java.io.IOException { + // Encoding suspended? + if( suspendEncoding ) { + this.out.write( theBytes, off, len ); + return; + } // end if: supsended + + for( int i = 0; i < len; i++ ) { + write( theBytes[ off + i ] ); + } // end for: each byte written + + } // end write + + + + /** + * Method added by PHIL. [Thanks, PHIL. -Rob] + * This pads the buffer without closing the stream. + * @throws java.io.IOException if there's an error. + */ + public void flushBase64() throws java.io.IOException { + if( position > 0 ) { + if( encode ) { + out.write( encode3to4( b4, buffer, position, options ) ); + position = 0; + } // end if: encoding + else { + throw new java.io.IOException( "Base64 input not properly padded." ); + } // end else: decoding + } // end if: buffer partially full + + } // end flush + + + /** + * Flushes and closes (I think, in the superclass) the stream. + * + * @since 1.3 + */ + @Override + public void close() throws java.io.IOException { + // 1. Ensure that pending characters are written + flushBase64(); + + // 2. Actually close the stream + // Base class both flushes and closes. + super.close(); + + buffer = null; + out = null; + } // end close + + + + /** + * Suspends encoding of the stream. + * May be helpful if you need to embed a piece of + * base64-encoded data in a stream. + * + * @throws java.io.IOException if there's an error flushing + * @since 1.5.1 + */ + public void suspendEncoding() throws java.io.IOException { + flushBase64(); + this.suspendEncoding = true; + } // end suspendEncoding + + + /** + * Resumes encoding of the stream. + * May be helpful if you need to embed a piece of + * base64-encoded data in a stream. + * + * @since 1.5.1 + */ + public void resumeEncoding() { + this.suspendEncoding = false; + } // end resumeEncoding + + + + } // end inner class OutputStream + + +} // end class Base64 diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/ByteArrayAdapter.java b/src/main/java/org/whispersystems/textsecuregcm/util/ByteArrayAdapter.java new file mode 100644 index 000000000..217716e25 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/ByteArrayAdapter.java @@ -0,0 +1,50 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + + +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.JsonSerializer; +import com.fasterxml.jackson.databind.SerializerProvider; + +import java.io.IOException; + +public class ByteArrayAdapter { + + public static class Serializing extends JsonSerializer { + @Override + public void serialize(byte[] bytes, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) + throws IOException, JsonProcessingException + { + jsonGenerator.writeString(Base64.encodeBytesWithoutPadding(bytes)); + } + } + + public static class Deserializing extends JsonDeserializer { + @Override + public byte[] deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) + throws IOException, JsonProcessingException + { + return Base64.decodeWithoutPadding(jsonParser.getValueAsString()); + } + } +} + diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/Conversions.java b/src/main/java/org/whispersystems/textsecuregcm/util/Conversions.java new file mode 100644 index 000000000..05e537cdc --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/Conversions.java @@ -0,0 +1,180 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +public class Conversions { + + public static byte intsToByteHighAndLow(int highValue, int lowValue) { + return (byte)((highValue << 4 | lowValue) & 0xFF); + } + + public static int highBitsToInt(byte value) { + return (value & 0xFF) >> 4; + } + + public static int lowBitsToInt(byte value) { + return (value & 0xF); + } + + public static int highBitsToMedium(int value) { + return (value >> 12); + } + + public static int lowBitsToMedium(int value) { + return (value & 0xFFF); + } + + public static byte[] shortToByteArray(int value) { + byte[] bytes = new byte[2]; + shortToByteArray(bytes, 0, value); + return bytes; + } + + public static int shortToByteArray(byte[] bytes, int offset, int value) { + bytes[offset+1] = (byte)value; + bytes[offset] = (byte)(value >> 8); + return 2; + } + + public static int shortToLittleEndianByteArray(byte[] bytes, int offset, int value) { + bytes[offset] = (byte)value; + bytes[offset+1] = (byte)(value >> 8); + return 2; + } + + public static byte[] mediumToByteArray(int value) { + byte[] bytes = new byte[3]; + mediumToByteArray(bytes, 0, value); + return bytes; + } + + public static int mediumToByteArray(byte[] bytes, int offset, int value) { + bytes[offset + 2] = (byte)value; + bytes[offset + 1] = (byte)(value >> 8); + bytes[offset] = (byte)(value >> 16); + return 3; + } + + public static byte[] intToByteArray(int value) { + byte[] bytes = new byte[4]; + intToByteArray(bytes, 0, value); + return bytes; + } + + public static int intToByteArray(byte[] bytes, int offset, int value) { + bytes[offset + 3] = (byte)value; + bytes[offset + 2] = (byte)(value >> 8); + bytes[offset + 1] = (byte)(value >> 16); + bytes[offset] = (byte)(value >> 24); + return 4; + } + + public static int intToLittleEndianByteArray(byte[] bytes, int offset, int value) { + bytes[offset] = (byte)value; + bytes[offset+1] = (byte)(value >> 8); + bytes[offset+2] = (byte)(value >> 16); + bytes[offset+3] = (byte)(value >> 24); + return 4; + } + + public static byte[] longToByteArray(long l) { + byte[] bytes = new byte[8]; + longToByteArray(bytes, 0, l); + return bytes; + } + + public static int longToByteArray(byte[] bytes, int offset, long value) { + bytes[offset + 7] = (byte)value; + bytes[offset + 6] = (byte)(value >> 8); + bytes[offset + 5] = (byte)(value >> 16); + bytes[offset + 4] = (byte)(value >> 24); + bytes[offset + 3] = (byte)(value >> 32); + bytes[offset + 2] = (byte)(value >> 40); + bytes[offset + 1] = (byte)(value >> 48); + bytes[offset] = (byte)(value >> 56); + return 8; + } + + public static int longTo4ByteArray(byte[] bytes, int offset, long value) { + bytes[offset + 3] = (byte)value; + bytes[offset + 2] = (byte)(value >> 8); + bytes[offset + 1] = (byte)(value >> 16); + bytes[offset + 0] = (byte)(value >> 24); + return 4; + } + + public static int byteArrayToShort(byte[] bytes) { + return byteArrayToShort(bytes, 0); + } + + public static int byteArrayToShort(byte[] bytes, int offset) { + return + (bytes[offset] & 0xff) << 8 | (bytes[offset + 1] & 0xff); + } + + // The SSL patented 3-byte Value. + public static int byteArrayToMedium(byte[] bytes, int offset) { + return + (bytes[offset] & 0xff) << 16 | + (bytes[offset + 1] & 0xff) << 8 | + (bytes[offset + 2] & 0xff); + } + + public static int byteArrayToInt(byte[] bytes) { + return byteArrayToInt(bytes, 0); + } + + public static int byteArrayToInt(byte[] bytes, int offset) { + return + (bytes[offset] & 0xff) << 24 | + (bytes[offset + 1] & 0xff) << 16 | + (bytes[offset + 2] & 0xff) << 8 | + (bytes[offset + 3] & 0xff); + } + + public static int byteArrayToIntLittleEndian(byte[] bytes, int offset) { + return + (bytes[offset + 3] & 0xff) << 24 | + (bytes[offset + 2] & 0xff) << 16 | + (bytes[offset + 1] & 0xff) << 8 | + (bytes[offset] & 0xff); + } + + public static long byteArrayToLong(byte[] bytes) { + return byteArrayToLong(bytes, 0); + } + + public static long byteArray4ToLong(byte[] bytes, int offset) { + return + ((bytes[offset + 0] & 0xffL) << 24) | + ((bytes[offset + 1] & 0xffL) << 16) | + ((bytes[offset + 2] & 0xffL) << 8) | + ((bytes[offset + 3] & 0xffL)); + } + + public static long byteArrayToLong(byte[] bytes, int offset) { + return + ((bytes[offset] & 0xffL) << 56) | + ((bytes[offset + 1] & 0xffL) << 48) | + ((bytes[offset + 2] & 0xffL) << 40) | + ((bytes[offset + 3] & 0xffL) << 32) | + ((bytes[offset + 4] & 0xffL) << 24) | + ((bytes[offset + 5] & 0xffL) << 16) | + ((bytes[offset + 6] & 0xffL) << 8) | + ((bytes[offset + 7] & 0xffL)); + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/Hex.java b/src/main/java/org/whispersystems/textsecuregcm/util/Hex.java new file mode 100644 index 000000000..6e3e9d912 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/Hex.java @@ -0,0 +1,109 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +/** + * Utility for generating hex dumps a la hexl-mode in emacs. + */ +public class Hex { + + private final static int HEX_DIGITS_START = 10; + private final static int ASCII_TEXT_START = HEX_DIGITS_START + (16*2 + (16/2)); + + final static String EOL = System.getProperty("line.separator"); + + private final static char[] HEX_DIGITS = { + '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' + }; + + public static String toString(byte[] bytes) { + return toString(bytes, 0, bytes.length); + } + + public static String toString(byte[] bytes, int offset, int length) { + StringBuffer buf = new StringBuffer(); + for (int i = 0; i < length; i++) { + appendHexChar(buf, bytes[offset + i]); + buf.append(' '); + } + return buf.toString(); + } + + public static String dump(byte[] bytes) { + return dump(bytes, 0, bytes.length); + } + + public static String dump(byte[] bytes, int offset, int length) { + StringBuffer buf = new StringBuffer(); + int lines = ((length - 1) / 16) + 1; + int lineOffset; + int lineLength; + + for (int i = 0; i < lines; i++) { + lineOffset = (i * 16) + offset; + lineLength = Math.min(16, (length - (i * 16))); + appendDumpLine(buf, i, bytes, lineOffset, lineLength); + buf.append(EOL); + } + + return buf.toString(); + } + + private static void appendDumpLine(StringBuffer buf, int line, + byte[] bytes, int lineOffset, + int lineLength) + { + buf.append(HEX_DIGITS[(line >> 28) & 0xf]); + buf.append(HEX_DIGITS[(line >> 24) & 0xf]); + buf.append(HEX_DIGITS[(line >> 20) & 0xf]); + buf.append(HEX_DIGITS[(line >> 16) & 0xf]); + buf.append(HEX_DIGITS[(line >> 12) & 0xf]); + buf.append(HEX_DIGITS[(line >> 8) & 0xf]); + buf.append(HEX_DIGITS[(line >> 4) & 0xf]); + buf.append(HEX_DIGITS[(line ) & 0xf]); + buf.append(": "); + + for (int i = 0; i < 16; i++) { + int idx = i + lineOffset; + if (i < lineLength) { + int b = bytes[idx]; + appendHexChar(buf, b); + } else { + buf.append(" "); + } + if ((i % 2) == 1) { + buf.append(' '); + } + } + + for (int i = 0; i < 16 && i < lineLength; i++) { + int idx = i + lineOffset; + int b = bytes[idx]; + if (b >= 0x20 && b <= 0x7e) { + buf.append((char)b); + } else { + buf.append('.'); + } + } + } + + private static void appendHexChar(StringBuffer buf, int b) { + buf.append(HEX_DIGITS[(b >> 4) & 0xf]); + buf.append(HEX_DIGITS[b & 0xf]); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/IterablePair.java b/src/main/java/org/whispersystems/textsecuregcm/util/IterablePair.java new file mode 100644 index 000000000..854812aa5 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/IterablePair.java @@ -0,0 +1,77 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +import java.util.Iterator; +import java.util.List; + +public class IterablePair implements Iterable> { + private final List first; + private final List second; + + public IterablePair(List first, List second) { + this.first = first; + this.second = second; + } + + @Override + public Iterator> iterator(){ + return new ParallelIterator<>( first.iterator(), second.iterator() ); + } + + public static class Pair { + private final T1 v1; + private final T2 v2; + + Pair(T1 v1, T2 v2) { + this.v1 = v1; + this.v2 = v2; + } + + public T1 first(){ + return v1; + } + + public T2 second(){ + return v2; + } + } + + public static class ParallelIterator implements Iterator> { + + private final Iterator it1; + private final Iterator it2; + + public ParallelIterator(Iterator it1, Iterator it2) { + this.it1 = it1; this.it2 = it2; + } + + @Override + public boolean hasNext() { return it1.hasNext() && it2.hasNext(); } + + @Override + public Pair next() { + return new Pair<>(it1.next(), it2.next()); + } + + @Override + public void remove(){ + it1.remove(); + it2.remove(); + } + } +} \ No newline at end of file diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/UrlSigner.java b/src/main/java/org/whispersystems/textsecuregcm/util/UrlSigner.java new file mode 100644 index 000000000..c7f1e55df --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/UrlSigner.java @@ -0,0 +1,52 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +import com.amazonaws.HttpMethod; +import com.amazonaws.auth.AWSCredentials; +import com.amazonaws.auth.BasicAWSCredentials; +import com.amazonaws.services.s3.AmazonS3; +import com.amazonaws.services.s3.AmazonS3Client; +import com.amazonaws.services.s3.model.GeneratePresignedUrlRequest; +import org.whispersystems.textsecuregcm.configuration.S3Configuration; + +import java.net.URL; +import java.util.Date; + +public class UrlSigner { + + private static final long DURATION = 60 * 60 * 1000; + + private final AWSCredentials credentials; + private final String bucket; + + public UrlSigner(S3Configuration config) { + this.credentials = new BasicAWSCredentials(config.getAccessKey(), config.getAccessSecret()); + this.bucket = config.getAttachmentsBucket(); + } + + public URL getPreSignedUrl(long attachmentId, HttpMethod method) { + AmazonS3 client = new AmazonS3Client(credentials); + GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(bucket, String.valueOf(attachmentId), method); + + request.setExpiration(new Date(System.currentTimeMillis() + DURATION)); + request.setContentType("application/octet-stream"); + + return client.generatePresignedUrl(request); + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/Util.java b/src/main/java/org/whispersystems/textsecuregcm/util/Util.java new file mode 100644 index 000000000..8b9b960f6 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/Util.java @@ -0,0 +1,86 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +import java.io.UnsupportedEncodingException; +import java.net.URLEncoder; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Map; + +public class Util { + + public static byte[] getContactToken(String number) { + try { + MessageDigest digest = MessageDigest.getInstance("SHA1"); + byte[] result = digest.digest(number.getBytes()); + byte[] truncated = Util.truncate(result, 10); + + return truncated; + } catch (NoSuchAlgorithmException e) { + throw new AssertionError(e); + } + } + + public static String getEncodedContactToken(String number) { + return Base64.encodeBytesWithoutPadding(getContactToken(number)); + } + + public static boolean isValidNumber(String number) { + return number.matches("^\\+[0-9]{10,}"); + } + + public static String encodeFormParams(Map params) { + try { + StringBuffer buffer = new StringBuffer(); + + for (String key : params.keySet()) { + buffer.append(String.format("%s=%s", + URLEncoder.encode(key, "UTF-8"), + URLEncoder.encode(params.get(key), "UTF-8"))); + buffer.append("&"); + } + + buffer.deleteCharAt(buffer.length()-1); + return buffer.toString(); + } catch (UnsupportedEncodingException e) { + throw new AssertionError(e); + } + } + + public static boolean isEmpty(String param) { + return param == null || param.length() == 0; + } + + public static byte[] combine(byte[] one, byte[] two, byte[] three, byte[] four) { + byte[] combined = new byte[one.length + two.length + three.length + four.length]; + System.arraycopy(one, 0, combined, 0, one.length); + System.arraycopy(two, 0, combined, one.length, two.length); + System.arraycopy(three, 0, combined, one.length + two.length, three.length); + System.arraycopy(four, 0, combined, one.length + two.length + three.length, four.length); + + return combined; + } + + public static byte[] truncate(byte[] element, int length) { + byte[] result = new byte[length]; + System.arraycopy(element, 0, result, 0, result.length); + + return result; + } + +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/util/VerificationCode.java b/src/main/java/org/whispersystems/textsecuregcm/util/VerificationCode.java new file mode 100644 index 000000000..e77b38770 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/util/VerificationCode.java @@ -0,0 +1,57 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.util; + +public class VerificationCode { + + private String verificationCode; + private String verificationCodeDisplay; + private String verificationCodeSpeech; + + public VerificationCode(int verificationCode) { + this.verificationCode = verificationCode + ""; + this.verificationCodeDisplay = this.verificationCode.substring(0, 3) + "-" + + this.verificationCode.substring(3, 6); + this.verificationCodeSpeech = delimit(verificationCode + ""); + } + + public String getVerificationCode() { + return verificationCode; + } + + public String getVerificationCodeDisplay() { + return verificationCodeDisplay; + } + + public String getVerificationCodeSpeech() { + return verificationCodeSpeech; + } + + private String delimit(String code) { + String delimited = ""; + + for (int i=0;i. + */ +package org.whispersystems.textsecuregcm.workers; + +import com.yammer.dropwizard.cli.ConfiguredCommand; +import com.yammer.dropwizard.config.Bootstrap; +import com.yammer.dropwizard.db.DatabaseConfiguration; +import com.yammer.dropwizard.jdbi.ImmutableListContainerFactory; +import com.yammer.dropwizard.jdbi.ImmutableSetContainerFactory; +import com.yammer.dropwizard.jdbi.OptionalContainerFactory; +import com.yammer.dropwizard.jdbi.args.OptionalArgumentFactory; +import net.sourceforge.argparse4j.inf.Namespace; +import net.spy.memcached.MemcachedClient; +import org.skife.jdbi.v2.DBI; +import org.whispersystems.textsecuregcm.WhisperServerConfiguration; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.providers.MemcachedClientFactory; +import org.whispersystems.textsecuregcm.providers.RedisClientFactory; +import org.whispersystems.textsecuregcm.storage.Accounts; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.DirectoryManager; + +import redis.clients.jedis.JedisPool; + +public class DirectoryCommand extends ConfiguredCommand { + + public DirectoryCommand() { + super("directory", "Update directory from DB and peers."); + } + + @Override + protected void run(Bootstrap bootstrap, + Namespace namespace, + WhisperServerConfiguration config) + throws Exception + { + try { + DatabaseConfiguration dbConfig = config.getDatabaseConfiguration(); + DBI dbi = new DBI(dbConfig.getUrl(), dbConfig.getUser(), dbConfig.getPassword()); + + dbi.registerArgumentFactory(new OptionalArgumentFactory(dbConfig.getDriverClass())); + dbi.registerContainerFactory(new ImmutableListContainerFactory()); + dbi.registerContainerFactory(new ImmutableSetContainerFactory()); + dbi.registerContainerFactory(new OptionalContainerFactory()); + + Accounts accounts = dbi.onDemand(Accounts.class); + MemcachedClient memcachedClient = new MemcachedClientFactory(config.getMemcacheConfiguration()).getClient(); + JedisPool redisClient = new RedisClientFactory(config.getRedisConfiguration()).getRedisClientPool(); + DirectoryManager directory = new DirectoryManager(redisClient); + AccountsManager accountsManager = new AccountsManager(accounts, directory, memcachedClient); + FederatedClientManager federatedClientManager = new FederatedClientManager(config.getFederationConfiguration()); + + DirectoryUpdater update = new DirectoryUpdater(accountsManager, federatedClientManager, directory); + + update.updateFromLocalDatabase(); + update.updateFromPeers(); + } finally { + Thread.sleep(3000); + System.exit(0); + } + } +} diff --git a/src/main/java/org/whispersystems/textsecuregcm/workers/DirectoryUpdater.java b/src/main/java/org/whispersystems/textsecuregcm/workers/DirectoryUpdater.java new file mode 100644 index 000000000..b489b2a59 --- /dev/null +++ b/src/main/java/org/whispersystems/textsecuregcm/workers/DirectoryUpdater.java @@ -0,0 +1,126 @@ +/** + * Copyright (C) 2013 Open WhisperSystems + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ +package org.whispersystems.textsecuregcm.workers; + +import com.google.common.base.Optional; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.federation.FederatedClient; +import org.whispersystems.textsecuregcm.federation.FederatedClientManager; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.DirectoryManager; +import org.whispersystems.textsecuregcm.storage.DirectoryManager.BatchOperationHandle; +import org.whispersystems.textsecuregcm.util.Base64; +import org.whispersystems.textsecuregcm.util.Util; + +import java.util.Iterator; +import java.util.List; + +public class DirectoryUpdater { + + private final Logger logger = LoggerFactory.getLogger(DirectoryUpdater.class); + + private final AccountsManager accountsManager; + private final FederatedClientManager federatedClientManager; + private final DirectoryManager directory; + + public DirectoryUpdater(AccountsManager accountsManager, + FederatedClientManager federatedClientManager, + DirectoryManager directory) + { + this.accountsManager = accountsManager; + this.federatedClientManager = federatedClientManager; + this.directory = directory; + } + + public void updateFromLocalDatabase() { + BatchOperationHandle batchOperation = directory.startBatchOperation(); + + try { + Iterator accounts = accountsManager.getAll(); + + if (accounts == null) + return; + + while (accounts.hasNext()) { + Account account = accounts.next(); + if (account.getApnRegistrationId() != null || account.getGcmRegistrationId() != null) { + byte[] token = Util.getContactToken(account.getNumber()); + ClientContact clientContact = new ClientContact(token, null, account.getSupportsSms()); + + directory.add(batchOperation, clientContact); + + logger.debug("Adding local token: " + Base64.encodeBytesWithoutPadding(token)); + } else { + directory.remove(batchOperation, account.getNumber()); + } + } + } finally { + directory.stopBatchOperation(batchOperation); + } + + logger.info("Local directory is updated."); + } + + public void updateFromPeers() { + logger.info("Updating peer directories."); + List clients = federatedClientManager.getClients(); + + for (FederatedClient client : clients) { + logger.info("Updating directory from peer: " + client.getPeerName()); + BatchOperationHandle handle = directory.startBatchOperation(); + + try { + int userCount = client.getUserCount(); + int retrieved = 0; + + logger.info("Remote peer user count: " + userCount); + + while (retrieved < userCount) { + List clientContacts = client.getUserTokens(retrieved); + + if (clientContacts == null) + break; + + for (ClientContact clientContact : clientContacts) { + clientContact.setRelay(client.getPeerName()); + + Optional existing = directory.get(clientContact.getToken()); + + if (!clientContact.isInactive() && (!existing.isPresent() || existing.get().getRelay().equals(client.getPeerName()))) { + directory.add(handle, clientContact); + } else { + if (existing != null && client.getPeerName().equals(existing.get().getRelay())) { + directory.remove(clientContact.getToken()); + } + } + } + + retrieved += clientContacts.size(); + } + + logger.info("Update from peer complete."); + } finally { + directory.stopBatchOperation(handle); + } + } + + logger.info("Update from peer directories complete."); + } +} diff --git a/src/main/resources/banner.txt b/src/main/resources/banner.txt new file mode 100644 index 000000000..54abbfc3d --- /dev/null +++ b/src/main/resources/banner.txt @@ -0,0 +1,8 @@ + _ _ _ _ _____ +| | | | | (_) / ___| +| | | | |__ _ ___ _ __ ___ _ __\ `--. ___ _ ____ _____ _ __ +| |/\| | '_ \| / __| '_ \ / _ \ '__|`--. \/ _ \ '__\ \ / / _ \ '__| +\ /\ / | | | \__ \ |_) | __/ | /\__/ / __/ | \ V / __/ | + \/ \/|_| |_|_|___/ .__/ \___|_| \____/ \___|_| \_/ \___|_| + | | + |_| diff --git a/src/main/resources/migrations.xml b/src/main/resources/migrations.xml new file mode 100644 index 000000000..8f4ddf51a --- /dev/null +++ b/src/main/resources/migrations.xml @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/org/whispersystems/textsecuregcm/tests/BaseTest.java b/src/test/org/whispersystems/textsecuregcm/tests/BaseTest.java new file mode 100644 index 000000000..e45698e15 --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/BaseTest.java @@ -0,0 +1,11 @@ +package org.whispersystems.textsecuregcm.tests; + +/** + * Created with IntelliJ IDEA. + * User: moxie + * Date: 10/28/13 + * Time: 12:53 PM + * To change this template use File | Settings | File Templates. + */ +public class BaseTest { +} diff --git a/src/test/org/whispersystems/textsecuregcm/tests/controllers/AccountControllerTest.java b/src/test/org/whispersystems/textsecuregcm/tests/controllers/AccountControllerTest.java new file mode 100644 index 000000000..8c1dd1d1f --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/controllers/AccountControllerTest.java @@ -0,0 +1,91 @@ +package org.whispersystems.textsecuregcm.tests.controllers; + +import com.google.common.base.Optional; +import com.sun.jersey.api.client.ClientResponse; +import com.yammer.dropwizard.testing.ResourceTest; +import org.junit.Test; +import org.whispersystems.textsecuregcm.controllers.AccountController; +import org.whispersystems.textsecuregcm.entities.AccountAttributes; +import org.whispersystems.textsecuregcm.limits.RateLimiter; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.sms.SenderFactory; +import org.whispersystems.textsecuregcm.sms.TwilioSmsSender; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.storage.PendingAccountsManager; +import org.whispersystems.textsecuregcm.tests.util.AuthHelper; + +import javax.ws.rs.core.MediaType; + +import static org.fest.assertions.api.Assertions.assertThat; +import static org.mockito.Matchers.anyString; +import static org.mockito.Mockito.*; + +public class AccountControllerTest extends ResourceTest { + + private static final String SENDER = "+14152222222"; + + private PendingAccountsManager pendingAccountsManager = mock(PendingAccountsManager.class); + private AccountsManager accountsManager = mock(AccountsManager.class ); + private RateLimiters rateLimiters = mock(RateLimiters.class ); + private RateLimiter rateLimiter = mock(RateLimiter.class ); + private TwilioSmsSender twilioSmsSender = mock(TwilioSmsSender.class ); + private SenderFactory senderFactory = mock(SenderFactory.class ); + + @Override + protected void setUpResources() throws Exception { + addProvider(AuthHelper.getAuthenticator()); + + when(rateLimiters.getSmsDestinationLimiter()).thenReturn(rateLimiter); + when(rateLimiters.getVoiceDestinationLimiter()).thenReturn(rateLimiter); + when(rateLimiters.getVerifyLimiter()).thenReturn(rateLimiter); + + when(pendingAccountsManager.getCodeForNumber(SENDER)).thenReturn(Optional.of("1234")); + when(senderFactory.getSmsSender(SENDER)).thenReturn(twilioSmsSender); + + addResource(new AccountController(pendingAccountsManager, + accountsManager, + rateLimiters, + senderFactory)); + } + + @Test + public void testSendCode() throws Exception { + ClientResponse response = + client().resource(String.format("/v1/accounts/sms/code/%s", SENDER)) + .get(ClientResponse.class); + + assertThat(response.getStatus()).isEqualTo(200); + + verify(twilioSmsSender).deliverSmsVerification(eq(SENDER), anyString()); + } + + @Test + public void testVerifyCode() throws Exception { + ClientResponse response = + client().resource(String.format("/v1/accounts/code/%s", "1234")) + .header("Authorization", AuthHelper.getAuthHeader(SENDER, "bar")) + .entity(new AccountAttributes("keykeykeykey", false)) + .type(MediaType.APPLICATION_JSON_TYPE) + .put(ClientResponse.class); + + assertThat(response.getStatus()).isEqualTo(204); + + verify(accountsManager).create(isA(Account.class)); + } + + @Test + public void testVerifyBadCode() throws Exception { + ClientResponse response = + client().resource(String.format("/v1/accounts/code/%s", "1111")) + .header("Authorization", AuthHelper.getAuthHeader(SENDER, "bar")) + .entity(new AccountAttributes("keykeykeykey", false)) + .type(MediaType.APPLICATION_JSON_TYPE) + .put(ClientResponse.class); + + assertThat(response.getStatus()).isEqualTo(403); + + verifyNoMoreInteractions(accountsManager); + } + +} diff --git a/src/test/org/whispersystems/textsecuregcm/tests/controllers/KeyControllerTest.java b/src/test/org/whispersystems/textsecuregcm/tests/controllers/KeyControllerTest.java new file mode 100644 index 000000000..3b8bd886c --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/controllers/KeyControllerTest.java @@ -0,0 +1,82 @@ +package org.whispersystems.textsecuregcm.tests.controllers; + +import com.sun.jersey.api.client.ClientResponse; +import com.yammer.dropwizard.testing.ResourceTest; +import org.junit.Test; +import org.whispersystems.textsecuregcm.controllers.KeysController; +import org.whispersystems.textsecuregcm.entities.PreKey; +import org.whispersystems.textsecuregcm.limits.RateLimiter; +import org.whispersystems.textsecuregcm.limits.RateLimiters; +import org.whispersystems.textsecuregcm.storage.Keys; +import org.whispersystems.textsecuregcm.tests.util.AuthHelper; + +import static org.fest.assertions.api.Assertions.assertThat; +import static org.mockito.Mockito.*; + +public class KeyControllerTest extends ResourceTest { + + private final String EXISTS_NUMBER = "+14152222222"; + private final String NOT_EXISTS_NUMBER = "+14152222220"; + + private final PreKey SAMPLE_KEY = new PreKey(1, EXISTS_NUMBER, 1234, "test1", "test2", false); + private final Keys keys = mock(Keys.class); + + @Override + protected void setUpResources() { + addProvider(AuthHelper.getAuthenticator()); + + RateLimiters rateLimiters = mock(RateLimiters.class); + RateLimiter rateLimiter = mock(RateLimiter.class ); + + when(rateLimiters.getPreKeysLimiter()).thenReturn(rateLimiter); + + when(keys.get(EXISTS_NUMBER)).thenReturn(SAMPLE_KEY); + when(keys.get(NOT_EXISTS_NUMBER)).thenReturn(null); + + addResource(new KeysController(rateLimiters, keys, null)); + } + + @Test + public void validRequestTest() throws Exception { + PreKey result = client().resource(String.format("/v1/keys/%s", EXISTS_NUMBER)) + .header("Authorization", AuthHelper.getAuthHeader(AuthHelper.VALID_NUMBER, AuthHelper.VALID_PASSWORD)) + .get(PreKey.class); + + assertThat(result.getKeyId()).isEqualTo(SAMPLE_KEY.getKeyId()); + assertThat(result.getPublicKey()).isEqualTo(SAMPLE_KEY.getPublicKey()); + assertThat(result.getIdentityKey()).isEqualTo(SAMPLE_KEY.getIdentityKey()); + + assertThat(result.getId() == 0); + assertThat(result.getNumber() == null); + + verify(keys).get(EXISTS_NUMBER); + } + + @Test + public void invalidRequestTest() throws Exception { + ClientResponse response = client().resource(String.format("/v1/keys/%s", NOT_EXISTS_NUMBER)) + .header("Authorization", AuthHelper.getAuthHeader(AuthHelper.VALID_NUMBER, AuthHelper.VALID_PASSWORD)) + .get(ClientResponse.class); + + assertThat(response.getClientResponseStatus().getStatusCode()).isEqualTo(404); + + verify(keys).get(NOT_EXISTS_NUMBER); + } + + @Test + public void unauthorizedRequestTest() throws Exception { + ClientResponse response = + client().resource(String.format("/v1/keys/%s", NOT_EXISTS_NUMBER)) + .header("Authorization", AuthHelper.getAuthHeader(AuthHelper.VALID_NUMBER, AuthHelper.INVALID_PASSWORD)) + .get(ClientResponse.class); + + assertThat(response.getClientResponseStatus().getStatusCode()).isEqualTo(401); + + response = + client().resource(String.format("/v1/keys/%s", NOT_EXISTS_NUMBER)) + .get(ClientResponse.class); + + assertThat(response.getClientResponseStatus().getStatusCode()).isEqualTo(401); + } + +} \ No newline at end of file diff --git a/src/test/org/whispersystems/textsecuregcm/tests/entities/ClientContactTest.java b/src/test/org/whispersystems/textsecuregcm/tests/entities/ClientContactTest.java new file mode 100644 index 000000000..67144edb5 --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/entities/ClientContactTest.java @@ -0,0 +1,44 @@ +package org.whispersystems.textsecuregcm.tests.entities; + +import org.junit.Test; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.util.Util; + +import static com.yammer.dropwizard.testing.JsonHelpers.*; +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class ClientContactTest { + + @Test + public void serializeToJSON() throws Exception { + byte[] token = Util.getContactToken("+14152222222"); + ClientContact contact = new ClientContact(token, null, false); + ClientContact contactWithRelay = new ClientContact(token, "whisper", false); + ClientContact contactWithRelaySms = new ClientContact(token, "whisper", true ); + + assertThat("Basic Contact Serialization works", + asJson(contact), + is(equalTo(jsonFixture("fixtures/contact.json")))); + + assertThat("Contact Relay Serialization works", + asJson(contactWithRelay), + is(equalTo(jsonFixture("fixtures/contact.relay.json")))); + + assertThat("Contact Relay+SMS Serialization works", + asJson(contactWithRelaySms), + is(equalTo(jsonFixture("fixtures/contact.relay.sms.json")))); + } + + @Test + public void deserializeFromJSON() throws Exception { + ClientContact contact = new ClientContact(Util.getContactToken("+14152222222"), + "whisper", true); + + assertThat("a ClientContact can be deserialized from JSON", + fromJson(jsonFixture("fixtures/contact.relay.sms.json"), ClientContact.class), + is(contact)); + } + +} diff --git a/src/test/org/whispersystems/textsecuregcm/tests/entities/PreKeyTest.java b/src/test/org/whispersystems/textsecuregcm/tests/entities/PreKeyTest.java new file mode 100644 index 000000000..5295afc77 --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/entities/PreKeyTest.java @@ -0,0 +1,34 @@ +package org.whispersystems.textsecuregcm.tests.entities; + +import org.junit.Test; +import org.whispersystems.textsecuregcm.entities.ClientContact; +import org.whispersystems.textsecuregcm.entities.PreKey; +import org.whispersystems.textsecuregcm.util.Util; + +import static com.yammer.dropwizard.testing.JsonHelpers.*; +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class PreKeyTest { + + @Test + public void serializeToJSON() throws Exception { + PreKey preKey = new PreKey(1, "+14152222222", 1234, "test", "identityTest", false); + + assertThat("Basic Contact Serialization works", + asJson(preKey), + is(equalTo(jsonFixture("fixtures/prekey.json")))); + } + + @Test + public void deserializeFromJSON() throws Exception { + ClientContact contact = new ClientContact(Util.getContactToken("+14152222222"), + "whisper", true); + + assertThat("a ClientContact can be deserialized from JSON", + fromJson(jsonFixture("fixtures/contact.relay.sms.json"), ClientContact.class), + is(contact)); + } + +} diff --git a/src/test/org/whispersystems/textsecuregcm/tests/util/AuthHelper.java b/src/test/org/whispersystems/textsecuregcm/tests/util/AuthHelper.java new file mode 100644 index 000000000..636a01f73 --- /dev/null +++ b/src/test/org/whispersystems/textsecuregcm/tests/util/AuthHelper.java @@ -0,0 +1,44 @@ +package org.whispersystems.textsecuregcm.tests.util; + +import com.google.common.base.Optional; +import org.whispersystems.textsecuregcm.auth.AccountAuthenticator; +import org.whispersystems.textsecuregcm.auth.AuthenticationCredentials; +import org.whispersystems.textsecuregcm.auth.FederatedPeerAuthenticator; +import org.whispersystems.textsecuregcm.auth.MultiBasicAuthProvider; +import org.whispersystems.textsecuregcm.configuration.FederationConfiguration; +import org.whispersystems.textsecuregcm.federation.FederatedPeer; +import org.whispersystems.textsecuregcm.storage.Account; +import org.whispersystems.textsecuregcm.storage.AccountsManager; +import org.whispersystems.textsecuregcm.util.Base64; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class AuthHelper { + + public static final String VALID_NUMBER = "+14150000000"; + public static final String VALID_PASSWORD = "foo"; + + public static final String INVVALID_NUMBER = "+14151111111"; + public static final String INVALID_PASSWORD = "bar"; + + public static MultiBasicAuthProvider getAuthenticator() { + AccountsManager accounts = mock(AccountsManager.class); + Account account = mock(Account.class); + AuthenticationCredentials credentials = mock(AuthenticationCredentials.class); + + when(credentials.verify("foo")).thenReturn(true); + when(account.getAuthenticationCredentials()).thenReturn(credentials); + when(accounts.get(VALID_NUMBER)).thenReturn(Optional.of(account)); + + return new MultiBasicAuthProvider<>(new FederatedPeerAuthenticator(new FederationConfiguration()), + FederatedPeer.class, + new AccountAuthenticator(accounts), + Account.class, "WhisperServer"); + } + + public static String getAuthHeader(String number, String password) { + return "Basic " + Base64.encodeBytes((number + ":" + password).getBytes()); + } + +} diff --git a/src/test/resources/fixtures/contact.json b/src/test/resources/fixtures/contact.json new file mode 100644 index 000000000..0fd1282f4 --- /dev/null +++ b/src/test/resources/fixtures/contact.json @@ -0,0 +1,3 @@ +{ + "token" : "BQVVHxMt5zAFXA" +} \ No newline at end of file diff --git a/src/test/resources/fixtures/contact.relay.json b/src/test/resources/fixtures/contact.relay.json new file mode 100644 index 000000000..5661661c3 --- /dev/null +++ b/src/test/resources/fixtures/contact.relay.json @@ -0,0 +1,4 @@ +{ + "token" : "BQVVHxMt5zAFXA", + "relay" : "whisper" +} \ No newline at end of file diff --git a/src/test/resources/fixtures/contact.relay.sms.json b/src/test/resources/fixtures/contact.relay.sms.json new file mode 100644 index 000000000..4ec2d626e --- /dev/null +++ b/src/test/resources/fixtures/contact.relay.sms.json @@ -0,0 +1,5 @@ +{ + "token" : "BQVVHxMt5zAFXA", + "relay" : "whisper", + "supportsSms" : true +} \ No newline at end of file diff --git a/src/test/resources/fixtures/prekey.json b/src/test/resources/fixtures/prekey.json new file mode 100644 index 000000000..7197eb82d --- /dev/null +++ b/src/test/resources/fixtures/prekey.json @@ -0,0 +1,5 @@ +{ + "keyId" : 1234, + "publicKey" : "test", + "identityKey" : "identityTest" +} \ No newline at end of file diff --git a/system.properties b/system.properties new file mode 100644 index 000000000..97270b43f --- /dev/null +++ b/system.properties @@ -0,0 +1 @@ +java.runtime.version=1.7